create_alert
ChatGPTEmails site members when a goal is completed (trigger goal + goal_name), on every payment (payment) or on a customer's first payment (new_customer). Each email includes the source, location, device and a visitor journey link; a busy alert batches into an hourly summary. Requires the write scope.
create_funnel
ChatGPTSaves a funnel: ordered steps a visitor must reach in turn, ending for example in payment to see where buyers drop off. 1–8 comma-separated steps, counted in order: visit, page:/path (path prefix), page:=/path (exact page), page:host/path (one hostname), event:goal_name, identify, payment. Example: visit,page:/pricing,event:signup,payment. Show the user the name and steps before saving. Returns the funnel; report it with get_conversions and funnel_id. Up to 50 funnels per website. Requires the write scope (admin or owner).
create_goal_definition
ChatGPTCreates a goal from a page path ( one segment, * any), a link to another site, or a button text, form or file from automatic events; it counts past visits at once. Ask before calling. The name can't change later (set a display name with update_goal_customization). Requires the write scope.
create_note
ChatGPTAdds a note to the website's traffic chart, e.g. a launch or campaign. Requires the write scope.
create_segment
ChatGPTSaves a named set of report filters (for example paying customers from Google Ads) that the team can apply in the dashboard. Names are unique per website, ignoring case; up to 50 segments. Requires the write scope.
create_website
ChatGPTCreates a website on the account and returns its ID (for the tracking script) and its secret key. Requires the write scope on a token for all websites. Refused when another account has verified the domain (domain_taken: ask that site's owner for an invite, or claim it with its secret key in the dashboard) or when this account already has it (the error gives that website's ID). A domain other accounts only list can be added; whichever site verifies it first (its ID on the home page, a DNS TXT record or a managed proxy) owns it, and other accounts' copies stop collecting for it and are deleted 14 days later unless the domain is removed.
get_ad_spend
ChatGPTAd spend, impressions and clicks per campaign, ad group or ad for every connected ad network (Meta Ads, Google Ads, TikTok Ads), next to the ad visitors, customers, first-touch revenue and assisted revenue each brought, with ROAS and cost per customer. provider=all (default) adds combined totals across networks; accounts[] has each network's totals; several ad accounts per network are combined (adAccounts[] lists them, account= reports one alone). Meta and Google rows and per-network totals (accounts[].totals) also carry reportedValue/reportedPurchases/reportedRoas: what that network itself reports (Meta: purchase value and purchases; Google: metrics.conversions_value and conversions), converted into the report currency, for comparison only (never in revenue or ROAS); combined totals carry them only when one such network is in the report. Visits with only a click ID (fbclid, gclid, ttclid) are reported in unattributed and never counted in totals or ROAS. Spend is converted into the report currency.
get_ai_crawlers
ChatGPTRequests from AI crawlers (GPTBot, ClaudeBot, PerplexityBot, …) and other bots: by crawler, purpose and page.
get_ai_visibility
ChatGPTHow AI assistants (ChatGPT, Claude, Perplexity, Gemini, Grok, and when switched on Google AI Mode and Google AI Overviews) answer the website's tracked prompts, from weekly checks (an answer status of no_answer means Google showed no AI Overview for that search; it is not counted as not mentioned): visibility score (0–100, position-weighted), presence rate, average position, cited rate and consistency for the latest check and its trend across checks in the period (period defaults to 30d; use 90d or all for a longer trend), per-model results, the competitor leaderboard, per-prompt results and the most cited domains and pages. Prompts that name the website's own brand (branded: true) are left out of every figure, since assistants repeat a name the question contains (summary.excluded counts their answers), and a brand a question names gets no credit in its answers. Pass prompt_id for that prompt's latest answers (brands in order, sources). Reads stored checks only and never starts one; Growth plan, otherwise meta.locked is true.
get_alert_history
ChatGPTEmails sent by the website's alerts, newest first: alert, goal, instant or summary, conversions, status and errors.
get_bot_settings
ChatGPTWhich crawler companies and agents are excluded from bot tracking (dropped at ingest, not stored or counted), whether crawl events must carry the bot token, the token's status, the catalog of known companies and agents, and whether tracker hits from data-center networks are excluded (with how many were in the last 30 days). Works with account tokens and connected apps, not with a site secret key.
get_bot_usage
ChatGPTThe account's AI and bot requests this cycle: used, allowance, remaining, refused after the allowance ran out, reset date and websites that used them. Works with account tokens and connected apps, not with a site secret key.
get_breakdown
ChatGPTComplete ranked table for one dimension (channel, referrer, utmSource, page, entryPage, country, city, browser, device, outbound, …) with visitors, pageviews, revenue and payments. Supports search, sorting and paging.
get_conversions
ChatGPTGoal completions and conversion rates, paying customers, and each funnel's steps with drop-off. Each goal keeps its raw name plus displayName, color, description and hidden from the site's goal settings (hidden goals are still listed, with hidden: true).
get_errors
ChatGPTJavaScript errors visitors hit, grouped by name and message, with how many of those visitors didn't pay. Use to find errors that may block checkout on a page (path) or at a funnel step (funnel or steps + drop_step: the visitors who reached the step before drop_step and not drop_step, 0-based). group returns one group's sample stack and, with the visitors scope, the people who hit it. Needs JavaScript errors turned on in the website's settings (enabled says whether it is).
get_funnel_people
ChatGPTVisitors who left a funnel after a step (outcome dropped, the default) or went on to the next step (continued), newest first, with source, channel, country, when they reached the step and what they spent in the period. Use it to see who abandons before paying. Pass a saved funnel ID from list_funnels as funnel_id, or steps. step is 1-based (1 = the first step; the last step has no next step). Requires the visitors scope.
get_goal
ChatGPTOne custom goal: completions over time, its properties and the sources that drive it, with its display name, color, description and hidden flag.
get_insights
ChatGPTWhich channels, pages, countries and devices convert to buyers best, time to first purchase, and notable source changes.
get_managed_proxy
ChatGPTThe website's managed proxy: the customer subdomain that serves the tracker and receives events (one CNAME to MetricRaven, which handles the certificate), its status (pending_dns, issuing_certificate, active, error, or paused once the plan ended 30 days ago) and error, pausesAt while it keeps working after the plan ended, the DNS records to add, and the script tag to install once active. proxy is null when none is set up; available is false when the server has no provider. Enabling, re-checking and removing stay in the dashboard, CLI (metricraven proxy) or API. Works with account tokens and connected apps, not with a site secret key.
get_meta_ads
ChatGPTMeta (Facebook and Instagram) ads only. Spend, impressions and clicks per campaign, ad set or ad, next to the ad visitors, customers, first-touch and assisted revenue each brought, with ROAS and cost per customer (when Meta Ads is connected). fbclid-only visits are in unattributed, never in totals or ROAS.
get_mrr_history
ChatGPTMonthly recurring revenue over time: closing MRR, active, trialing and past-due subscriptions per day, week or month, with new, expansion, contraction and churned MRR (movements) and a summary. Days before recording began are reconstructed from subscription dates and flagged reconstructed: true. With compare (previous, year or a start date) previous.series has the comparison window bucket for bucket. Amounts convert into the report currency at each day's ECB rate; filters don't apply.
get_page_speed
ChatGPTPages where slow loads (Web Vitals) go with fewer buyers: slow vs fast visitors, the share of each that paid, estimated buyers lost, and LCP/INP at the 75th percentile. Use when asked whether site speed costs sales. Needs Page speed turned on in the website's settings.
get_path_visitors
ChatGPTVisitors who took a path from get_paths (pages, exact true for a whole path) or passed through pages at a step (at), newest first, with visitAt to pass to get_visitor as visit_at. Requires the visitors scope.
get_paths
ChatGPTMost common page sequences visitors took in the period (across visits, repeats merged, up to their first payment), with visitors, paying visitors, % that paid and revenue per path; paidPaths ranks the paths of people who paid, unpaidPaths of those who didn't; sankey has step-by-step flows. Use it to see which pages buyers go through before paying. Optional start_page / end_page anchor the paths; group=section merges /blog/* pages.
get_realtime
ChatGPTVisitors online right now with their current page, source, country and device. Names, emails, profile pictures and visitor IDs of identified people need the visitors scope.
get_revenue
ChatGPTPayments, new vs renewal revenue, refunds, MRR estimates, customers and lifetime value, credited to first-touch sources.
get_search_keywords
ChatGPTGoogle Search Console queries and pages with clicks, impressions, CTR and position (when Search Console is connected).
get_traffic
ChatGPTVisitors, pageviews, visits, bounce rate, session time, revenue, conversion rate and revenue per visitor, with the previous period, a time series, top channels, referrers, campaigns, pages, countries and devices, and spikes (days where one source such as X or Google sent far more visitors than usual; daily granularity).
get_visitor
ChatGPTOne visitor's profile and full journey: visits, pages, goals, payments, JavaScript errors and session recordings (replays: IDs, visit, length and pages; watch them in the dashboard). Requires the visitors scope.
get_visitor_traits
ChatGPTRevenue, customers and purchase rate per value of one custom identify trait (role, company size…) in the period. Use it to answer which kind of customer pays. People are identified users with a pageview or payment in the period; revenue is what they paid, split by their latest trait value. Personal traits are never returned. Requires the visitors scope.
get_x_referrers
ChatGPTVisitors and revenue from X by t.co link, each resolved to the X post that linked to the website (or a link-in-bio profile) when known. Posts resolve on the Growth plan.
list_alerts
ChatGPTThe website's conversion alerts (email when a goal, a payment or a new customer is recorded): trigger, recipients (and who opted out), enabled state and trigger counts. Also returns the goal names the site tracks and its members (recipient choices).
list_commits
ChatGPTCommits from the website's connected GitHub repository in the period (newest first): message, conventional type, author, time, lines changed. Useful to relate releases to traffic and revenue.
list_event_properties
ChatGPTProperty names seen on goal events in the period (or the values of one property, with people counts), to build a prop filter or pick a property for get_goal. Values are text: numbers and true/false come back as strings.
list_events
ChatGPTRaw pageviews, goal events and engagement pings, newest first, with page, referrer, UTM tags, location and device. Use it to check exactly what was recorded or to export; for totals use get_traffic or get_breakdown. Pass nextCursor back as cursor for the next page. Requires the visitors scope.
list_funnels
ChatGPTThe website's saved funnels and their steps.
list_goal_customizations
ChatGPTHow the website's goals are shown: per raw goal name, a display name, chart color, internal description and hidden flag (hidden goals are left out of dashboard lists, never out of the data). Also returns the allowed colors.
list_goal_definitions
ChatGPTGoals defined without code: name, kind (page, outbound, click, form or download) and its pattern (path, link host, button text, form or file). Their completions appear in get_conversions and get_goal like tracked goals.
list_members
ChatGPTThe website's team: members with email, name and role (owner, admin, viewer). For admins and the owner also pending invitations and plan seats. Works with account tokens and connected apps, not with a site secret key.
list_mentions
ChatGPTStored X posts and Reddit posts/comments that mention the website's domain or tracked keywords, newest first, with author, text, link and engagement (likes, reposts, replies or score, comments). Reads stored mentions only (collected weekly); Growth plan, otherwise meta.locked is true.
list_notes
ChatGPTNotes on the traffic chart (launches, campaigns, incidents) in the period.
list_payments
ChatGPTRaw payments, newest first, including refunds and free trials (flagged), each with the customer and the first visit that brought them (channel, source, landing page). Use it to see which traffic each sale came from. Pass nextCursor back as cursor. Requires the visitors scope.
list_segments
ChatGPTSaved segments: id, name, filters and revision. To report on a segment, pass its filters as the filters input of any report tool. Segments are private team settings, so this needs the visitors scope.
list_tokens
ChatGPTThe account's access tokens: names, hints, scopes, websites and last use (never their values). Read-only; manage tokens in Settings or with the CLI.
list_websites
ChatGPTLists the websites this connection can read, with their IDs (the website_id that reports take) and domains.
preview_goal_definition
ChatGPTBefore creating a goal without code, see how many visitors would have completed it in the last 30 days and how many of them paid. kind page needs path; outbound needs host (path optional); click needs text, form needs form and download needs file (a button text, form or file from automatic events).
search_visitors
ChatGPTVisitors in the period with source, location, pageviews and payments. Filters are visitor-level (any visit in the period); visit_* arguments instead require one single visit to match both the came-from and the reached condition (e.g. visit_source google.com and visit_page /pricing), and rows then carry matchedVisitAt (pass it to get_visitor as visit_at). Requires the visitors scope.
show_breakdown_chart
ChatGPTShows a ranked bar chart for one dimension (channel, referrer, utmSource, utmCampaign, page, entryPage, country, device, browser, os) with visitors and revenue for one website and period.
show_traffic_chart
ChatGPTShows an interactive chart of daily visitors and revenue for one website and period, with visitors, revenue, conversion rate, bounce rate, the change against the previous period and the top channels.
update_funnel
ChatGPTRenames a saved funnel or replaces its steps. Send only what changes. Reports use the new steps at once. Requires the write scope.
update_goal_customization
ChatGPTSets how one goal is shown: display name, color, internal description or hidden. Send only what changes; null clears a field. Tracking, filters and alerts keep the raw name. Requires the write scope and an admin or the owner.
update_goal_definition
ChatGPTChanges a goal's pattern: path, link host, button text, form or file, as its kind allows (its name and kind never change). Reports recount past visits at once. Requires the write scope.
update_segment
ChatGPTRenames a segment or replaces its filters. Needs its current revision from list_segments; if someone changed it since, call list_segments again and retry. Requires the write scope. Segment definitions are private team settings: without the visitors scope (Visitor details) the current values can't be read, so send both name and filters, with the segment_id and revision from the create_segment or last update_segment answer.