API reference
Read access to the Meta ads, Google Ads, organic social, YouTube, website (Google Analytics and Search Console), Shopify store, competitor-website and client add-on (GoKwik checkout, Zoho Books) data MetricsGo has synced for your organisation. All numbers are stored data — the API never calls Meta on your behalf; meta.syncedAt is the newest sync in scope and meta.freshness the oldest, per asset. Meta ads and social dates are IST calendar days; the Google and Shopify surfaces keep the source platform's own day boundary. Ranges may not exceed 366 days. null means "not reported", never zero. Keys must be sent as Authorization: Bearer from a server — this API sends no CORS headers on purpose.
- GET
/meThe calling key: org, scopes, brand restriction - GET
/clientsBrands (called `client` in the API for backwards compatibility) this key can read, with their ad accounts, Pages, Analytics properties, Search Console sites, Shopify stores, Google Ads accounts, YouTube channels, Merchant Center accounts, competitor count and a `connected` map - GET
/ads/overviewAds overview: KPIs, comparison period, daily series, funds, widgets - GET
/ads/entitiesCampaigns, ad sets or ads with range totals, ordered by sort/dir (capped at 500; see meta.truncated) - GET
/ads/breakdownsAge/gender, device, platform, placement and region for one entity (cached data only; see stale) - GET
/social/overviewFacebook Page and Instagram totals, comparison period and daily series - GET
/social/postsPosts published in the range with per-post metrics (newest first) - GET
/website/overviewGoogle Analytics: totals, previous period, daily series and the channel, source, landing page, event, device and country tables - GET
/website/behaviourMicrosoft Clarity behaviour: sessions, scroll depth, engagement time, rage / dead click, quick-back and JS-error session shares, daily series, top frustration pages and device, country, browser, OS, source and channel breakdowns - GET
/website/searchSearch Console: clicks, impressions, CTR, average position, daily series and the query, page, country, device and appearance tables - GET
/store/overviewShopify: sales ladder, orders, customers, AOV, daily series and the product, channel, referrer, country and discount tables - GET
/google-ads/overviewGoogle Ads: totals and derived rates, previous period, daily series, campaigns, channel types, devices, networks and conversion actions - GET
/youtube/overviewYouTube: views, watch minutes, average view duration, subscribers, daily series, top videos, traffic sources, devices and countries - GET
/competitorsCompetitor websites each brand watches, with status, logo, last check, products tracked and each site’s check state over `days` - GET
/competitors/changesGrouped competitor website changes detected in the range, with headlines and up to three example items each; or, with `group`, one group’s full change list - GET
/competitors/insightsRule-based competitor insights (sale share, launches, price cuts, sell-outs, banners, promo codes, pixels), the competitors with logos, live banner counts and each site’s check state over `days` - GET
/competitors/detailOne competitor: stats, insights, live banners, largest price moves, catalogue summary, site signals and recent checks (capped); or, with `dataset`, one page of its full product catalogue, price history, banners, SEO edits or check log - GET
/addons/gokwikGoKwik checkout add-on for one brand: KPIs, funnel, payment mix, coupons, UTM sources and campaigns, cities, states and a daily series - GET
/addons/zoho-booksZoho Books add-on for one brand: sales, collections, receivables and aging, expenses, gross profit, sales orders, 12-month trend, top customers, P&L by month and payables - GET
/shoppingGoogle Merchant Center for one brand: accounts, catalogue status counts, issues by severity, top issues, clicks/impressions/CTR/conversions with a daily series, top products and price-competitiveness benchmarks - GET
/shopping/productsOne page of a brand’s Merchant Center catalogue with item-level issues and range performance; filter by status, issue code or search; cursor-paged - GET
/overviewOne brand’s Overview page: per-platform health, a card per connected platform with KPIs, trend and highlights, the outcome grid, movers, Meta signals, attention list and competitors card - GET
/overview/rosterEvery brand the key covers: connected platforms, each platform’s headline KPI with previous and delta, freshness, health and attention items - GET
/ads/signalsMeta ads signals: entity movements versus the previous period that are unusual against their siblings (robust z ≥ 3 and ≥ 10%), ranked by score - GET
/ads/pacingMonth-to-date Meta budget pacing: spend, resolved month budget and its source, projection, daily paces and an under / on_track / over / unknown status - GET
/social/thumbnailStored thumbnail bytes for one post
/me
any scopeThe calling key: org, scopes, brand restriction
Query parameters
None.
Response 200
{ data, meta } — data is:
keyobjectidstringnamestringprefixstringexpiresAtstring | null
orgobjectidstringnamestring
scopesarray of stringclientIdsarray of string | null
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/clients
any scopeBrands (called `client` in the API for backwards compatibility) this key can read, with their ad accounts, Pages, Analytics properties, Search Console sites, Shopify stores, Google Ads accounts, YouTube channels, Merchant Center accounts, competitor count and a `connected` map
Query parameters
None.
Response 200
{ data, meta } — data is:
idstringnamestringadAccountsarray of objectidstringplatformAccountIdstringnamestringcurrencystring | nulllastSyncedAtstring | null
pagesarray of objectpageIdstringnamestringigIdstring | nulloptionaligUsernamestring | null
analyticsPropertiesarray of objectpropertyIdstringnamestringtimezonestring | nulllastSyncedAtstring | null
searchConsoleSitesarray of objectsiteUrlstringlastSyncedAtstring | null
shopifyStoresarray of objectshopDomainstringnamestring | nullcurrencystring | nulltimezonestring | nulllastSyncedAtstring | null
googleAdsAccountsarray of objectcustomerIdstringnamestringcurrencystring | nulltimezonestring | nulllastSyncedAtstring | null
youtubeChannelsarray of objectchannelIdstringnamestringcustomUrlstring | nullsubscriberCountnumber | nulllastSyncedAtstring | null
merchantAccountsarray of objectmerchantIdstringnamestringregistrationStatusstring | nulllastSyncedAtstring | null
competitorsWatchednumberclarityProjectsarray of objectlabelstringstatusstringlastSyncedAtstring | null
connectedobjectmetaAdsbooleanfacebookbooleaninstagrambooleangoogleAnalyticsbooleansearchConsolebooleanshopifybooleangoogleAdsbooleanyoutubebooleanmerchantCenterbooleancompetitorsbooleanclarityboolean
addonsarray of one of: gokwik, zoho_books
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/ads/overview
scope ads:readAds overview: KPIs, comparison period, daily series, funds, widgets
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | no |
| from | string | yes |
| to | string | yes |
| campaignId | string | no |
| adSetId | string | no |
| adId | string | no |
| compare | one of: previous, prevMonth, prevYear, none · default previous | no |
Response 200
{ data, meta } — data is:
moneyobjectcurrencystring | nullcurrenciesarray of stringmixedbooleanunknownnumberbyCurrencyarray of objectcurrencystring | null
compareobject | nullfromstringtostring
kpisobjectspendnumber | nullimpressionsnumberreachnumberclicksnumberctrnumbercpcnumber | nullvideoViewsnumberpurchaseValuenumber | nullresultsnumberresultTypestring | nullcostPerResultnumber | null
previousobject | nullspendnumber | nullresultsnumberimpressionsnumberclicksnumberreachnumber
fundsobjectbalancenumber | nullspentnumber | nullcapnumber | nullbyCurrencyarray of objectoptionalcurrencystring | nullremainingLimitnumber | nullprepaidFundsnumber | nullowednumber | nullspentnumber | null
updatedAtstring | nulloptional
lowBalancearray of objectaccountNamestringbalancenumberthresholdnumbercurrencystring | null
seriesarray of objectdatestringspendnumber | nullimpressionsnumberclicksnumberreachnumberresultsnumber
campaignsarray of objectidstringnamestringstatusstring | nulleffectiveStatusstring | nullcurrencystring | nullspendnumberimpressionsnumberclicksnumberctrnumberaccountobject | nullidstringplatformAccountIdstringnamestring
clientobject | nullidstring | nullnamestring
widgetsobjectfunnelobjectimpressionsnumberreachnumberclicksnumberlinkClicksnumberresultsnumberresultTypestring | null
topCampaignsarray of objectplatformIdstringnamestringspendnumberresultsnumber | nullresultTypestring | nullcostPerResultnumber | nullctrnumberstatusstring | null
ageGenderarray of objectagestringgenderstringimpressionsnumberclicksnumberspendnumber | nullreachnumber
platformsarray of objectplatformstringimpressionsnumberspendnumber | nullclicksnumber
placementsarray of objectplatformstringpositionstringimpressionsnumberspendnumber | nullclicksnumber
videoobjectviews3snumberthruplaynumberp25numberp50numberp75numberp100number
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/ads/entities
scope ads:readCampaigns, ad sets or ads with range totals, ordered by sort/dir (capped at 500; see meta.truncated)
Query parameters
| Name | Type | Required |
|---|---|---|
| level | one of: campaign, adset, ad | yes |
| client | string (uuid) | no |
| from | string | yes |
| to | string | yes |
| search | string | no |
| sort | one of: spend, impressions, reach, clicks, results, ctr, cpc, costPerResult, frequency, name, delivery · default spend | no |
| dir | one of: asc, desc · default desc | no |
Response 200
{ data, meta } — data is:
rowsarray of objectidstringplatformIdstringnamestringstatusstring | nulleffectiveStatusstring | nullcurrencystring | nullspendnumberimpressionsnumberreachnumberclicksnumberlinkClicksnumberresultsnumber | nullresultTypestring | nullctrnumber | nullcpcnumber | nullcostPerResultnumber | nullfrequencynumber | nullthumbnailUrlstring | nulloptionalimageUrlstring | nulloptionalaccountobject | nullidstringplatformAccountIdstringnamestring
clientobject | nullidstring | nullnamestring
campaignobject | nullidstringplatformIdstringnamestringobjectivestring | null
adSetobject | nullidstringplatformIdstringnamestring
truncatedboolean
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/ads/breakdowns
scope ads:readAge/gender, device, platform, placement and region for one entity (cached data only; see stale)
Query parameters
| Name | Type | Required |
|---|---|---|
| level | one of: campaign, adset, ad | yes |
| entityId | string | yes |
| from | string | yes |
| to | string | yes |
Response 200
{ data, meta } — data is:
ageGenderarray of objectkey1stringkey2stringspendnumberimpressionsnumberclicksnumberreachnumber
devicearray of objectkey1stringkey2stringspendnumberimpressionsnumberclicksnumberreachnumber
platformarray of objectkey1stringkey2stringspendnumberimpressionsnumberclicksnumberreachnumber
placementarray of objectkey1stringkey2stringspendnumberimpressionsnumberclicksnumberreachnumber
regionarray of objectkey1stringkey2stringspendnumberimpressionsnumberclicksnumberreachnumber
syncedAtstring | nullstaleboolean
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/website/overview
scope web:readGoogle Analytics: totals, previous period, daily series and the channel, source, landing page, event, device and country tables
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | no |
| from | string | yes |
| to | string | yes |
| compare | one of: previous, prevMonth, prevYear, none · default previous | no |
| limit | integer · default 25 · min 1 · max 100 | no |
Response 200
{ data, meta } — data is:
fromstringtostringcompareobject | nullfromstringtostring
analyticsobject | nullpropertiesarray of objectidstringnamestringtimezonestring | nulllastSyncedAtstring | null
currencystring | nullmoneyobjectcurrencystring | nullcurrenciesarray of stringmixedbooleanunknownnumberbyCurrencyarray of objectcurrencystring | null
totalsobjectsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
previousobject | nullsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
seriesarray of objectdatestringsessionsnumber | nulltotalUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullkeyEventsnumber | nulltotalRevenuenumber | null
previousSeriesarray of objectdatestringsessionsnumber | nulltotalUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullkeyEventsnumber | nulltotalRevenuenumber | null
channelsarray of objectkeystringlabelstringdetailstringoptionaltotalsobjectsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
previousobject | nullsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
sourcesarray of objectkeystringlabelstringdetailstringoptionaltotalsobjectsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
previousobject | nullsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
landingPagesarray of objectkeystringlabelstringdetailstringoptionaltotalsobjectsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
previousobject | nullsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
organicLandingPagesarray of objectkeystringlabelstringdetailstringoptionaltotalsobjectsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
previousobject | nullsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
pagesarray of objectkeystringlabelstringdetailstringoptionaltotalsobjectsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
previousobject | nullsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
eventsarray of objectkeystringlabelstringdetailstringoptionaltotalsobjectsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
previousobject | nullsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
devicesarray of objectkeystringlabelstringdetailstringoptionaltotalsobjectsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
previousobject | nullsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
countriesarray of objectkeystringlabelstringdetailstringoptionaltotalsobjectsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
previousobject | nullsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
newReturningarray of objectkeystringlabelstringdetailstringoptionaltotalsobjectsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
previousobject | nullsessionsnumber | nulltotalUsersnumber | nullactiveUsersnumber | nullnewUsersnumber | nullengagedSessionsnumber | nullscreenPageViewsnumber | nulleventCountnumber | nullkeyEventsnumber | nulltotalRevenuenumber | nullpurchaseRevenuenumber | nulltransactionsnumber | nullecommercePurchasesnumber | nulluserEngagementDurationnumber | nullsessionDurationWeightednumber | nullengagementRatenumber | nullbounceRatenumber | nullaverageSessionDurationnumber | nullsessionsPerUsernumber | nullscreenPageViewsPerSessionnumber | nulleventCountPerUsernumber | nullconversionRatenumber | nullrevenuePerSessionnumber | null
partialboolean
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/website/behaviour
scope web:readMicrosoft Clarity behaviour: sessions, scroll depth, engagement time, rage / dead click, quick-back and JS-error session shares, daily series, top frustration pages and device, country, browser, OS, source and channel breakdowns
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | no |
| from | string | yes |
| to | string | yes |
| compare | one of: previous, prevMonth, prevYear, none · default previous | no |
| limit | integer · default 25 · min 1 · max 100 | no |
Response 200
{ data, meta } — data is:
connectedbooleanprojectsarray of objectclientIdstringlabelstringstatusstringconnectedAtstringlastSyncedAtstring | nulldashboardUrlstring | null
historyStartsOnstring | nulltotalsobject | nullsessionsnumber | nullbotSessionsnumber | nullusersnumber | nullpagesPerSessionnumber | nullscrollDepthnumber | nulltotalTimenumber | nullactiveTimenumber | nulldeadClicksnumber | nulldeadClickRatenumber | nullrageClicksnumber | nullrageClickRatenumber | nullexcessiveScrollsnumber | nullexcessiveScrollRatenumber | nullquickbacksnumber | nullquickbackRatenumber | nullscriptErrorsnumber | nullscriptErrorRatenumber | nullerrorClicksnumber | nullerrorClickRatenumber | null
previousobject | nullsessionsnumber | nullbotSessionsnumber | nullusersnumber | nullpagesPerSessionnumber | nullscrollDepthnumber | nulltotalTimenumber | nullactiveTimenumber | nulldeadClicksnumber | nulldeadClickRatenumber | nullrageClicksnumber | nullrageClickRatenumber | nullexcessiveScrollsnumber | nullexcessiveScrollRatenumber | nullquickbacksnumber | nullquickbackRatenumber | nullscriptErrorsnumber | nullscriptErrorRatenumber | nullerrorClicksnumber | nullerrorClickRatenumber | null
compareobject | nullfromstringtostring
seriesarray of objectsessionsnumber | nullbotSessionsnumber | nullusersnumber | nullpagesPerSessionnumber | nullscrollDepthnumber | nulltotalTimenumber | nullactiveTimenumber | nulldeadClicksnumber | nulldeadClickRatenumber | nullrageClicksnumber | nullrageClickRatenumber | nullexcessiveScrollsnumber | nullexcessiveScrollRatenumber | nullquickbacksnumber | nullquickbackRatenumber | nullscriptErrorsnumber | nullscriptErrorRatenumber | nullerrorClicksnumber | nullerrorClickRatenumber | nulldatestring
previousSeriesarray of objectsessionsnumber | nullbotSessionsnumber | nullusersnumber | nullpagesPerSessionnumber | nullscrollDepthnumber | nulltotalTimenumber | nullactiveTimenumber | nulldeadClicksnumber | nulldeadClickRatenumber | nullrageClicksnumber | nullrageClickRatenumber | nullexcessiveScrollsnumber | nullexcessiveScrollRatenumber | nullquickbacksnumber | nullquickbackRatenumber | nullscriptErrorsnumber | nullscriptErrorRatenumber | nullerrorClicksnumber | nullerrorClickRatenumber | nulldatestring
topFrustrationPagesarray of objecturlstringsessionsnumber | nullrageClickRatenumber | nulldeadClickRatenumber | nullquickbackRatenumber | nullscriptErrorsnumber | nullscriptErrorRatenumber | nullclarityUrlstring | null
devicesarray of objectlabelstringsessionsnumber | nullrageClickRatenumber | nulldeadClickRatenumber | nullquickbackRatenumber | nullscriptErrorRatenumber | null
countriesarray of objectlabelstringsessionsnumber | nullrageClickRatenumber | nulldeadClickRatenumber | nullquickbackRatenumber | nullscriptErrorRatenumber | null
browsersarray of objectlabelstringsessionsnumber | nullrageClickRatenumber | nulldeadClickRatenumber | nullquickbackRatenumber | nullscriptErrorRatenumber | null
operatingSystemsarray of objectlabelstringsessionsnumber | nullrageClickRatenumber | nulldeadClickRatenumber | nullquickbackRatenumber | nullscriptErrorRatenumber | null
sourcesarray of objectlabelstringsessionsnumber | nullrageClickRatenumber | nulldeadClickRatenumber | nullquickbackRatenumber | nullscriptErrorRatenumber | null
channelsarray of objectlabelstringsessionsnumber | nullrageClickRatenumber | nulldeadClickRatenumber | nullquickbackRatenumber | nullscriptErrorRatenumber | null
notesarray of string
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/website/search
scope web:readSearch Console: clicks, impressions, CTR, average position, daily series and the query, page, country, device and appearance tables
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | no |
| from | string | yes |
| to | string | yes |
| compare | one of: previous, prevMonth, prevYear, none · default previous | no |
| searchType | one of: web, image, video, news, discover, googleNews · default web | no |
| limit | integer · default 25 · min 1 · max 100 | no |
Response 200
{ data, meta } — data is:
fromstringtostringcompareobject | nullfromstringtostring
searchobject | nullsitesarray of objectidstringsiteUrlstringlastSyncedAtstring | nullfirstIncompleteDatestring | null
searchTypestringtotalsobjectclicksnumber | nullimpressionsnumber | nullpositionWeightednumber | nullctrnumber | nullpositionnumber | null
previousobject | nullclicksnumber | nullimpressionsnumber | nullpositionWeightednumber | nullctrnumber | nullpositionnumber | null
seriesarray of objectdatestringclicksnumber | nullimpressionsnumber | nullctrnumber | nullpositionnumber | null
previousSeriesarray of objectdatestringclicksnumber | nullimpressionsnumber | nullctrnumber | nullpositionnumber | null
queriesarray of objectkeystringlabelstringtotalsobjectclicksnumber | nullimpressionsnumber | nullpositionWeightednumber | nullctrnumber | nullpositionnumber | null
previousobject | nullclicksnumber | nullimpressionsnumber | nullpositionWeightednumber | nullctrnumber | nullpositionnumber | null
pagesarray of objectkeystringlabelstringtotalsobjectclicksnumber | nullimpressionsnumber | nullpositionWeightednumber | nullctrnumber | nullpositionnumber | null
previousobject | nullclicksnumber | nullimpressionsnumber | nullpositionWeightednumber | nullctrnumber | nullpositionnumber | null
countriesarray of objectkeystringlabelstringtotalsobjectclicksnumber | nullimpressionsnumber | nullpositionWeightednumber | nullctrnumber | nullpositionnumber | null
previousobject | nullclicksnumber | nullimpressionsnumber | nullpositionWeightednumber | nullctrnumber | nullpositionnumber | null
devicesarray of objectkeystringlabelstringtotalsobjectclicksnumber | nullimpressionsnumber | nullpositionWeightednumber | nullctrnumber | nullpositionnumber | null
previousobject | nullclicksnumber | nullimpressionsnumber | nullpositionWeightednumber | nullctrnumber | nullpositionnumber | null
appearancesarray of objectkeystringlabelstringtotalsobjectclicksnumber | nullimpressionsnumber | nullpositionWeightednumber | nullctrnumber | nullpositionnumber | null
previousobject | nullclicksnumber | nullimpressionsnumber | nullpositionWeightednumber | nullctrnumber | nullpositionnumber | null
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/store/overview
scope store:readShopify: sales ladder, orders, customers, AOV, daily series and the product, channel, referrer, country and discount tables
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | no |
| from | string | yes |
| to | string | yes |
| compare | one of: previous, prevMonth, prevYear, none · default previous | no |
| limit | integer · default 25 · min 1 · max 100 | no |
Response 200
{ data, meta } — data is:
fromstringtostringcompareobject | nullfromstringtostring
storeobject | nullstoresarray of objectidstringshopDomainstringshopNamestring | nulltimezonestring | nulllastSyncedAtstring | nullhasAllOrdersScopeboolean
currencystring | nullmoneyobjectcurrencystring | nullcurrenciesarray of stringmixedbooleanunknownnumberbyCurrencyarray of objectcurrencystring | null
totalsobjectgrossSalesnumber | nulldiscountsnumber | nullreturnsnumber | nullnetSalesnumber | nullshippingnumber | nulltaxesnumber | nulldutiesnumber | nulltipsnumber | nulltotalSalesnumber | nullordersnumber | nullcancelledOrdersnumber | nullrefundedOrdersnumber | nullunitsSoldnumber | nullcustomersnumber | nullnewCustomersnumber | nullreturningCustomersnumber | nullaverageOrderValuenumber | nullaverageUnitsPerOrdernumber | nullreturnRatenumber | nulldiscountRatenumber | nullnewCustomerRatenumber | nullrevenuePerCustomernumber | null
previousobject | nullgrossSalesnumber | nulldiscountsnumber | nullreturnsnumber | nullnetSalesnumber | nullshippingnumber | nulltaxesnumber | nulldutiesnumber | nulltipsnumber | nulltotalSalesnumber | nullordersnumber | nullcancelledOrdersnumber | nullrefundedOrdersnumber | nullunitsSoldnumber | nullcustomersnumber | nullnewCustomersnumber | nullreturningCustomersnumber | nullaverageOrderValuenumber | nullaverageUnitsPerOrdernumber | nullreturnRatenumber | nulldiscountRatenumber | nullnewCustomerRatenumber | nullrevenuePerCustomernumber | null
seriesarray of objectdatestringnetSalesnumber | nullgrossSalesnumber | nullordersnumber | nullunitsSoldnumber | nullreturnsnumber | nullnewCustomersnumber | null
previousSeriesarray of objectdatestringnetSalesnumber | nullgrossSalesnumber | nullordersnumber | nullunitsSoldnumber | nullreturnsnumber | nullnewCustomersnumber | null
productsarray of objectkeystringlabelstringdetailstringoptionalimagestringoptionaltotalsobjectgrossSalesnumber | nulldiscountsnumber | nullreturnsnumber | nullnetSalesnumber | nullshippingnumber | nulltaxesnumber | nulldutiesnumber | nulltipsnumber | nulltotalSalesnumber | nullordersnumber | nullcancelledOrdersnumber | nullrefundedOrdersnumber | nullunitsSoldnumber | nullcustomersnumber | nullnewCustomersnumber | nullreturningCustomersnumber | nullaverageOrderValuenumber | nullaverageUnitsPerOrdernumber | nullreturnRatenumber | nulldiscountRatenumber | nullnewCustomerRatenumber | nullrevenuePerCustomernumber | null
previousobject | nullgrossSalesnumber | nulldiscountsnumber | nullreturnsnumber | nullnetSalesnumber | nullshippingnumber | nulltaxesnumber | nulldutiesnumber | nulltipsnumber | nulltotalSalesnumber | nullordersnumber | nullcancelledOrdersnumber | nullrefundedOrdersnumber | nullunitsSoldnumber | nullcustomersnumber | nullnewCustomersnumber | nullreturningCustomersnumber | nullaverageOrderValuenumber | nullaverageUnitsPerOrdernumber | nullreturnRatenumber | nulldiscountRatenumber | nullnewCustomerRatenumber | nullrevenuePerCustomernumber | null
channelsarray of objectkeystringlabelstringdetailstringoptionalimagestringoptionaltotalsobjectgrossSalesnumber | nulldiscountsnumber | nullreturnsnumber | nullnetSalesnumber | nullshippingnumber | nulltaxesnumber | nulldutiesnumber | nulltipsnumber | nulltotalSalesnumber | nullordersnumber | nullcancelledOrdersnumber | nullrefundedOrdersnumber | nullunitsSoldnumber | nullcustomersnumber | nullnewCustomersnumber | nullreturningCustomersnumber | nullaverageOrderValuenumber | nullaverageUnitsPerOrdernumber | nullreturnRatenumber | nulldiscountRatenumber | nullnewCustomerRatenumber | nullrevenuePerCustomernumber | null
previousobject | nullgrossSalesnumber | nulldiscountsnumber | nullreturnsnumber | nullnetSalesnumber | nullshippingnumber | nulltaxesnumber | nulldutiesnumber | nulltipsnumber | nulltotalSalesnumber | nullordersnumber | nullcancelledOrdersnumber | nullrefundedOrdersnumber | nullunitsSoldnumber | nullcustomersnumber | nullnewCustomersnumber | nullreturningCustomersnumber | nullaverageOrderValuenumber | nullaverageUnitsPerOrdernumber | nullreturnRatenumber | nulldiscountRatenumber | nullnewCustomerRatenumber | nullrevenuePerCustomernumber | null
referrersarray of objectkeystringlabelstringdetailstringoptionalimagestringoptionaltotalsobjectgrossSalesnumber | nulldiscountsnumber | nullreturnsnumber | nullnetSalesnumber | nullshippingnumber | nulltaxesnumber | nulldutiesnumber | nulltipsnumber | nulltotalSalesnumber | nullordersnumber | nullcancelledOrdersnumber | nullrefundedOrdersnumber | nullunitsSoldnumber | nullcustomersnumber | nullnewCustomersnumber | nullreturningCustomersnumber | nullaverageOrderValuenumber | nullaverageUnitsPerOrdernumber | nullreturnRatenumber | nulldiscountRatenumber | nullnewCustomerRatenumber | nullrevenuePerCustomernumber | null
previousobject | nullgrossSalesnumber | nulldiscountsnumber | nullreturnsnumber | nullnetSalesnumber | nullshippingnumber | nulltaxesnumber | nulldutiesnumber | nulltipsnumber | nulltotalSalesnumber | nullordersnumber | nullcancelledOrdersnumber | nullrefundedOrdersnumber | nullunitsSoldnumber | nullcustomersnumber | nullnewCustomersnumber | nullreturningCustomersnumber | nullaverageOrderValuenumber | nullaverageUnitsPerOrdernumber | nullreturnRatenumber | nulldiscountRatenumber | nullnewCustomerRatenumber | nullrevenuePerCustomernumber | null
countriesarray of objectkeystringlabelstringdetailstringoptionalimagestringoptionaltotalsobjectgrossSalesnumber | nulldiscountsnumber | nullreturnsnumber | nullnetSalesnumber | nullshippingnumber | nulltaxesnumber | nulldutiesnumber | nulltipsnumber | nulltotalSalesnumber | nullordersnumber | nullcancelledOrdersnumber | nullrefundedOrdersnumber | nullunitsSoldnumber | nullcustomersnumber | nullnewCustomersnumber | nullreturningCustomersnumber | nullaverageOrderValuenumber | nullaverageUnitsPerOrdernumber | nullreturnRatenumber | nulldiscountRatenumber | nullnewCustomerRatenumber | nullrevenuePerCustomernumber | null
previousobject | nullgrossSalesnumber | nulldiscountsnumber | nullreturnsnumber | nullnetSalesnumber | nullshippingnumber | nulltaxesnumber | nulldutiesnumber | nulltipsnumber | nulltotalSalesnumber | nullordersnumber | nullcancelledOrdersnumber | nullrefundedOrdersnumber | nullunitsSoldnumber | nullcustomersnumber | nullnewCustomersnumber | nullreturningCustomersnumber | nullaverageOrderValuenumber | nullaverageUnitsPerOrdernumber | nullreturnRatenumber | nulldiscountRatenumber | nullnewCustomerRatenumber | nullrevenuePerCustomernumber | null
discountsarray of objectkeystringlabelstringdetailstringoptionalimagestringoptionaltotalsobjectgrossSalesnumber | nulldiscountsnumber | nullreturnsnumber | nullnetSalesnumber | nullshippingnumber | nulltaxesnumber | nulldutiesnumber | nulltipsnumber | nulltotalSalesnumber | nullordersnumber | nullcancelledOrdersnumber | nullrefundedOrdersnumber | nullunitsSoldnumber | nullcustomersnumber | nullnewCustomersnumber | nullreturningCustomersnumber | nullaverageOrderValuenumber | nullaverageUnitsPerOrdernumber | nullreturnRatenumber | nulldiscountRatenumber | nullnewCustomerRatenumber | nullrevenuePerCustomernumber | null
previousobject | nullgrossSalesnumber | nulldiscountsnumber | nullreturnsnumber | nullnetSalesnumber | nullshippingnumber | nulltaxesnumber | nulldutiesnumber | nulltipsnumber | nulltotalSalesnumber | nullordersnumber | nullcancelledOrdersnumber | nullrefundedOrdersnumber | nullunitsSoldnumber | nullcustomersnumber | nullnewCustomersnumber | nullreturningCustomersnumber | nullaverageOrderValuenumber | nullaverageUnitsPerOrdernumber | nullreturnRatenumber | nulldiscountRatenumber | nullnewCustomerRatenumber | nullrevenuePerCustomernumber | null
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/google-ads/overview
scope ads:readGoogle Ads: totals and derived rates, previous period, daily series, campaigns, channel types, devices, networks and conversion actions
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | no |
| from | string | yes |
| to | string | yes |
| compare | one of: previous, prevMonth, prevYear, none · default previous | no |
| limit | integer · default 25 · min 1 · max 100 | no |
Response 200
{ data, meta } — data is:
fromstringtostringcompareobject | nullfromstringtostring
adsobject | nullaccountsarray of objectidstringcustomerIdstringdescriptiveNamestringcurrencystring | nulltimezonestring | nulllastSyncedAtstring | null
currencystring | nullmoneyobjectcurrencystring | nullcurrenciesarray of stringmixedbooleanunknownnumberbyCurrencyarray of objectcurrencystring | null
totalsobjectimpressionsnumber | nullclicksnumber | nullcostnumber | nullconversionsnumber | nullconversionsValuenumber | nullallConversionsnumber | nullvideoViewsnumber | nullinteractionsnumber | nullctrnumber | nullaverageCpcnumber | nullcostPerConversionnumber | nullconversionRatenumber | nullroasnumber | nullviewRatenumber | null
previousobject | nullimpressionsnumber | nullclicksnumber | nullcostnumber | nullconversionsnumber | nullconversionsValuenumber | nullallConversionsnumber | nullvideoViewsnumber | nullinteractionsnumber | nullctrnumber | nullaverageCpcnumber | nullcostPerConversionnumber | nullconversionRatenumber | nullroasnumber | nullviewRatenumber | null
seriesarray of objectdatestringimpressionsnumber | nullclicksnumber | nullcostnumber | nullconversionsnumber | nullconversionsValuenumber | nullvideoViewsnumber | null
previousSeriesarray of objectdatestringimpressionsnumber | nullclicksnumber | nullcostnumber | nullconversionsnumber | nullconversionsValuenumber | nullvideoViewsnumber | null
campaignsarray of objectidstringnamestringcurrencystring | nullstatusstring | nullchannelTypestring | nulltotalsobjectimpressionsnumber | nullclicksnumber | nullcostnumber | nullconversionsnumber | nullconversionsValuenumber | nullallConversionsnumber | nullvideoViewsnumber | nullinteractionsnumber | nullctrnumber | nullaverageCpcnumber | nullcostPerConversionnumber | nullconversionRatenumber | nullroasnumber | nullviewRatenumber | null
previousobject | nullimpressionsnumber | nullclicksnumber | nullcostnumber | nullconversionsnumber | nullconversionsValuenumber | nullallConversionsnumber | nullvideoViewsnumber | nullinteractionsnumber | nullctrnumber | nullaverageCpcnumber | nullcostPerConversionnumber | nullconversionRatenumber | nullroasnumber | nullviewRatenumber | null
channelTypesarray of objectkeystringlabelstringtotalsobjectimpressionsnumber | nullclicksnumber | nullcostnumber | nullconversionsnumber | nullconversionsValuenumber | nullallConversionsnumber | nullvideoViewsnumber | nullinteractionsnumber | nullctrnumber | nullaverageCpcnumber | nullcostPerConversionnumber | nullconversionRatenumber | nullroasnumber | nullviewRatenumber | null
previousobject | nullimpressionsnumber | nullclicksnumber | nullcostnumber | nullconversionsnumber | nullconversionsValuenumber | nullallConversionsnumber | nullvideoViewsnumber | nullinteractionsnumber | nullctrnumber | nullaverageCpcnumber | nullcostPerConversionnumber | nullconversionRatenumber | nullroasnumber | nullviewRatenumber | null
devicesarray of objectkeystringlabelstringtotalsobjectimpressionsnumber | nullclicksnumber | nullcostnumber | nullconversionsnumber | nullconversionsValuenumber | nullallConversionsnumber | nullvideoViewsnumber | nullinteractionsnumber | nullctrnumber | nullaverageCpcnumber | nullcostPerConversionnumber | nullconversionRatenumber | nullroasnumber | nullviewRatenumber | null
previousobject | nullimpressionsnumber | nullclicksnumber | nullcostnumber | nullconversionsnumber | nullconversionsValuenumber | nullallConversionsnumber | nullvideoViewsnumber | nullinteractionsnumber | nullctrnumber | nullaverageCpcnumber | nullcostPerConversionnumber | nullconversionRatenumber | nullroasnumber | nullviewRatenumber | null
networksarray of objectkeystringlabelstringtotalsobjectimpressionsnumber | nullclicksnumber | nullcostnumber | nullconversionsnumber | nullconversionsValuenumber | nullallConversionsnumber | nullvideoViewsnumber | nullinteractionsnumber | nullctrnumber | nullaverageCpcnumber | nullcostPerConversionnumber | nullconversionRatenumber | nullroasnumber | nullviewRatenumber | null
previousobject | nullimpressionsnumber | nullclicksnumber | nullcostnumber | nullconversionsnumber | nullconversionsValuenumber | nullallConversionsnumber | nullvideoViewsnumber | nullinteractionsnumber | nullctrnumber | nullaverageCpcnumber | nullcostPerConversionnumber | nullconversionRatenumber | nullroasnumber | nullviewRatenumber | null
conversionActionsarray of objectnamestringcategorystringconversionsnumber | nullvaluenumber | null
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/youtube/overview
scope social:readYouTube: views, watch minutes, average view duration, subscribers, daily series, top videos, traffic sources, devices and countries
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | no |
| from | string | yes |
| to | string | yes |
| compare | one of: previous, prevMonth, prevYear, none · default previous | no |
| limit | integer · default 25 · min 1 · max 100 | no |
Response 200
{ data, meta } — data is:
fromstringtostringcompareobject | nullfromstringtostring
youtubeobject | nullchannelsarray of objectidstringchannelIdstringtitlestringcustomUrlstring | nullsubscriberCountnumber | nulllastSyncedAtstring | null
totalsobjectviewsnumber | nullestimatedMinutesWatchednumber | nullsubscribersGainednumber | nullsubscribersLostnumber | nulllikesnumber | nullcommentsnumber | nullsharesnumber | nullaverageViewDurationSecondsnumber | nullnetSubscribersnumber | nullengagementsnumber | null
previousobject | nullviewsnumber | nullestimatedMinutesWatchednumber | nullsubscribersGainednumber | nullsubscribersLostnumber | nulllikesnumber | nullcommentsnumber | nullsharesnumber | nullaverageViewDurationSecondsnumber | nullnetSubscribersnumber | nullengagementsnumber | null
seriesarray of objectdatestringviewsnumber | nullminutesWatchednumber | nullnetSubscribersnumber | null
previousSeriesarray of objectdatestringviewsnumber | nullminutesWatchednumber | nullnetSubscribersnumber | null
videosarray of objectidstringvideoIdstringtitlestringpublishedAtstring | nulldurationSecondsnumber | nullwatchUrlstringthumbnailUrlstringtotalsobjectviewsnumber | nullminutesWatchednumber | nulllikesnumber | nullcommentsnumber | nullsharesnumber | null
previousobject | nullviewsnumber | nullminutesWatchednumber | nulllikesnumber | nullcommentsnumber | nullsharesnumber | null
trafficSourcesarray of objectkeystringlabelstringtotalsobjectviewsnumber | nullminutesWatchednumber | null
previousobject | nullviewsnumber | nullminutesWatchednumber | null
devicesarray of objectkeystringlabelstringtotalsobjectviewsnumber | nullminutesWatchednumber | null
previousobject | nullviewsnumber | nullminutesWatchednumber | null
countriesarray of objectkeystringlabelstringtotalsobjectviewsnumber | nullminutesWatchednumber | null
previousobject | nullviewsnumber | nullminutesWatchednumber | null
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/competitors
scope competitors:readCompetitor websites each brand watches, with status, logo, last check, products tracked and each site’s check state over `days`
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | no |
| days | integer · default 1 · min 1 · max 90 | no |
Response 200
{ data, meta } — data is:
competitorsarray of objectidstringclientobjectidstringnamestring
namestringhoststringsiteUrlstringplatformstringstatusstringlastCheckAtstring | nullnextCheckAtstring | nullproductsTrackednumberlogoUrlstring | nullcheckobjectcompetitorIdstringstateone of: changed, checked_no_changes, partial, failed, stale, paused, unsupported, pendinglastAttemptAtstring | nulllastAttemptStatusstring | nulllastSuccessAtstring | nullpartialbooleanstalebooleanchangeGroupsInWindownumberchangeEventsInWindownumber
windowobjectkindone of: rolling, ist_daysdaysnumberfromstringtostringfromDaystring
scopeobjectoptionalmodeone of: whole_site, selectedsitewidebooleanitemsarray of objectkindone of: collection, path_prefixkeystringlabelstringmissingboolean
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/competitors/changes
scope competitors:readGrouped competitor website changes detected in the range, with headlines and up to three example items each; or, with `group`, one group’s full change list
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | no |
| competitor | string (uuid) | no |
| from | string | yes |
| to | string | yes |
| minSeverity | integer · default 1 · min 1 · max 5 | no |
| limit | integer · default 50 · min 1 · max 200 | no |
| cursor | string | no |
| group | string | no |
Response 200
{ data, meta } — data is:
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/competitors/insights
scope competitors:readRule-based competitor insights (sale share, launches, price cuts, sell-outs, banners, promo codes, pixels), the competitors with logos, live banner counts and each site’s check state over `days`
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | no |
| days | integer · default 1 · min 1 · max 90 | no |
Response 200
{ data, meta } — data is:
insightsarray of objectkindstringcompetitorIdstring | nullcompetitorNamestring | nullfigurestringunitstringsentencestringimageUrlsarray of string
competitorsWatchednumbercompetitorsarray of objectidstringclientIdstringnamestringlogoUrlstring | null
bannersTotalnumberbannersLiveBySiteobjectsitesarray of objectcompetitorIdstringstateone of: changed, checked_no_changes, partial, failed, stale, paused, unsupported, pendinglastAttemptAtstring | nulllastAttemptStatusstring | nulllastSuccessAtstring | nullpartialbooleanstalebooleanchangeGroupsInWindownumberchangeEventsInWindownumber
windowobjectkindone of: rolling, ist_daysdaysnumberfromstringtostringfromDaystring
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/competitors/detail
scope competitors:readOne competitor: stats, insights, live banners, largest price moves, catalogue summary, site signals and recent checks (capped); or, with `dataset`, one page of its full product catalogue, price history, banners, SEO edits or check log
Query parameters
| Name | Type | Required |
|---|---|---|
| competitor | string (uuid) | yes |
| dataset | one of: products, banners, seo, runs, price_history | no |
| cursor | string | no |
| limit | integer · min 1 · max 500 | no |
Response 200
{ data, meta } — data is:
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/addons/gokwik
scope store:readGoKwik checkout add-on for one brand: KPIs, funnel, payment mix, coupons, UTM sources and campaigns, cities, states and a daily series
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | yes |
| from | string | no |
| to | string | no |
Response 200
{ data, meta } — data is:
clientobjectidstringnamestring
currencystring | nullmoneyobjectcurrencystring | nullcurrenciesarray of stringmixedbooleanunknownnumberbyCurrencyarray of objectcurrencystring | null
dataKindstringeventCountnumberlastEventReceivedAtstring | nullreconciliationobject | nullshopifyOrdersnumbershopifyNetSalesnumber | nullcurrencystring | nulldifferenceobjectordersnumberrevenuenumber | null
provenanceobjectoffStoreOriginEventsnumberunknownOriginEventsnumberoriginHostsarray of objecthoststringeventsnumberexpectedboolean
droppedEventsnumberdroppedByReasonarray of objectreasonstringcountnumber
kpisobjectcheckoutsStartednumberordersPlacednumberconversionRatenumber | nullrevenuenumber | nullaverageOrderValuenumber | nullcodSharenumber | nullunmatchedOrdersnumberoptionalordersWithAmountnumberoptionalordersWithPaymentMethodnumberoptional
funnelarray of objectstepstringlabelstringcountnumberstepConversionnumber | nulldropOffnumber | nullnotestring | nulloptional
paymentMethodsarray of objectmethodstringordersnumber
couponsarray of objectcodestringappliednumberfailednumberdiscountGivennumber
utmSourcesarray of objectsourcestringcheckoutsStartednumberordersPlacednumber
utmCampaignsarray of objectcampaignstringcheckoutsStartednumberordersPlacednumber
citiesarray of objectcitystringordersnumber
statesarray of objectstatestringordersnumber
dailyarray of objectdatestringcheckoutsStartednumberordersPlacednumber
notesarray of string
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/addons/zoho-books
scope finance:readZoho Books add-on for one brand: sales, collections, receivables and aging, expenses, gross profit, sales orders, 12-month trend, top customers, P&L by month and payables
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | yes |
| from | string | no |
| to | string | no |
| org | string | no |
Response 200
{ data, meta } — data is:
clientobjectidstringnamestring
currencystringconnectionobject | nullstatusstringstatusReasonstring | nulllastSyncedAtstring | null
organizationsarray of objectidstringnamestring
orgstringbooksobject | nullasOfstringkpisobjectsalesnumberinvoiceCountnumbercollectionsnumberlastPaymentDatestring | nulloutstandingnumberoverduenumberexpensesnumbergrossProfitnumber | nullgrossProfitMonthsarray of stringsalesOrdersnumbersalesOrderValuenumber
monthlyTrendarray of objectmonthstringsalesnumbercollectionsnumberexpensesnumber
receivablesAgingarray of objectbucketstringbalancenumberinvoicesnumber
topCustomersByOutstandingarray of objectcustomerstringbalancenumberoverduenumberinvoicesnumber
topCustomersBySalesarray of objectcustomerstringsalesnumberinvoicesnumber
pnlByMontharray of objectmonthstringsalesnumber | nullcogsnumber | nullgrossProfitnumber | nulloperatingExpensenumber | nulloperatingProfitnumber | nullnetProfitnumber | null
payablesobjectopenBalancenumberoverduenumberopenBillsnumbervendorsarray of objectvendorstringbalancenumberbillsnumber
notesarray of string
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/shopping
scope store:readGoogle Merchant Center for one brand: accounts, catalogue status counts, issues by severity, top issues, clicks/impressions/CTR/conversions with a daily series, top products and price-competitiveness benchmarks
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | yes |
| from | string | no |
| to | string | no |
Response 200
{ data, meta } — data is:
clientobjectidstringnamestring
connectedbooleancurrencystring | nullaccountsarray of objectidstringmerchantIdstringnamestringlastSyncedAtstring | nullregistrationStatusstring | nullpriceCompetitivenessAvailableboolean | null
catalogueobjectproductsnumberapprovednumberlimitednumberpendingnumberdisapprovednumberproductsWithIssuesnumberissuesBySeverityarray of objectseveritystringproductsnumber
topIssuesarray of objectcodestringdescriptionstring | nullresolutionstring | nullseveritystring | nullproductsnumber
performanceobjectclicksnumberimpressionsnumberctrnumber | nullconversionsnumber | nullconversionValuenumber | null
seriesarray of objectdatestringclicksnumberimpressionsnumberfreeClicksnumber | nulladsClicksnumber | null
topProductsarray of objectofferIdstringmerchantIdstringtitlestring | nullbrandstring | nullstatusone of: approved, limited, pending, disapprovedpricenumber | nullsalePricenumber | nullcurrencystring | nullavailabilitystring | nulllinkstring | nullclicksnumberimpressionsnumberctrnumber | null
priceCompetitivenessobject | nullcapturedOnstring | nullcomparedProductsnumberpricedAboveBenchmarknumberpricedBelowOrAtBenchmarknumbertopPricedAbovearray of objectofferIdstringtitlestring | nullpricenumberbenchmarkPricenumbercurrencystring | nulldiffnumber
notesarray of string
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/shopping/products
scope store:readOne page of a brand’s Merchant Center catalogue with item-level issues and range performance; filter by status, issue code or search; cursor-paged
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | yes |
| from | string | no |
| to | string | no |
| status | one of: approved, limited, pending, disapproved | no |
| issue | string | no |
| search | string | no |
| cursor | string | no |
| limit | integer · default 50 · min 1 · max 200 | no |
Response 200
{ data, meta } — data is:
clientobjectidstringnamestring
connectedbooleancurrencystring | nulltotalnumberproductsarray of objectofferIdstringmerchantIdstringtitlestring | nullbrandstring | nullstatusone of: approved, limited, pending, disapprovedpricenumber | nullsalePricenumber | nullcurrencystring | nullavailabilitystring | nulllinkstring | nullclicksnumberimpressionsnumberctrnumber | nullconditionstring | nullproductTypestring | nullgoogleCategorystring | nullimageLinkstring | nullitemGroupIdstring | nullissuesarray of objectcodestringdescriptionstring | nullseveritystring | nullresolutionstring | nulldestinationsarray of string
firstSeenAtstringlastSeenAtstringconversionsnumber | nullconversionValuenumber | null
nextCursorstring | nullnotesarray of string
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/overview
scope ads:read social:read web:read store:readOne brand’s Overview page: per-platform health, a card per connected platform with KPIs, trend and highlights, the outcome grid, movers, Meta signals, attention list and competitors card
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | yes |
| from | string | yes |
| to | string | yes |
| compare | one of: previous, none · default previous | no |
Response 200
{ data, meta } — data is:
scopeobjectorgIdstringclientobjectidstringnamestringlogoHrefstring | null
fromstringtostringpreviousFromstring | nullpreviousTostring | nullreportingTimezonestringgeneratedAtstring
sourcesobjectmetaobjectstatusone of: ready, no_activity, not_connected, stale, partial, failedsyncedAtstring | nullcoverageobjectoptionalfromstring | nulltostring | null
timezoneNotestringmessagestringoptionalfreshnessobjectoptionalstatusone of: fresh, partial, stale, neveroldestSuccessAtstring | nullnewestSuccessAtstring | nullassetsarray of objectincompletearray of string
gadsobjectstatusone of: ready, no_activity, not_connected, stale, partial, failedsyncedAtstring | nullcoverageobjectoptionalfromstring | nulltostring | null
timezoneNotestringmessagestringoptionalfreshnessobjectoptionalstatusone of: fresh, partial, stale, neveroldestSuccessAtstring | nullnewestSuccessAtstring | nullassetsarray of objectincompletearray of string
instagramobjectstatusone of: ready, no_activity, not_connected, stale, partial, failedsyncedAtstring | nullcoverageobjectoptionalfromstring | nulltostring | null
timezoneNotestringmessagestringoptionalfreshnessobjectoptionalstatusone of: fresh, partial, stale, neveroldestSuccessAtstring | nullnewestSuccessAtstring | nullassetsarray of objectincompletearray of string
facebookobjectstatusone of: ready, no_activity, not_connected, stale, partial, failedsyncedAtstring | nullcoverageobjectoptionalfromstring | nulltostring | null
timezoneNotestringmessagestringoptionalfreshnessobjectoptionalstatusone of: fresh, partial, stale, neveroldestSuccessAtstring | nullnewestSuccessAtstring | nullassetsarray of objectincompletearray of string
youtubeobjectstatusone of: ready, no_activity, not_connected, stale, partial, failedsyncedAtstring | nullcoverageobjectoptionalfromstring | nulltostring | null
timezoneNotestringmessagestringoptionalfreshnessobjectoptionalstatusone of: fresh, partial, stale, neveroldestSuccessAtstring | nullnewestSuccessAtstring | nullassetsarray of objectincompletearray of string
ga4objectstatusone of: ready, no_activity, not_connected, stale, partial, failedsyncedAtstring | nullcoverageobjectoptionalfromstring | nulltostring | null
timezoneNotestringmessagestringoptionalfreshnessobjectoptionalstatusone of: fresh, partial, stale, neveroldestSuccessAtstring | nullnewestSuccessAtstring | nullassetsarray of objectincompletearray of string
gscobjectstatusone of: ready, no_activity, not_connected, stale, partial, failedsyncedAtstring | nullcoverageobjectoptionalfromstring | nulltostring | null
timezoneNotestringmessagestringoptionalfreshnessobjectoptionalstatusone of: fresh, partial, stale, neveroldestSuccessAtstring | nullnewestSuccessAtstring | nullassetsarray of objectincompletearray of string
shopifyobjectstatusone of: ready, no_activity, not_connected, stale, partial, failedsyncedAtstring | nullcoverageobjectoptionalfromstring | nulltostring | null
timezoneNotestringmessagestringoptionalfreshnessobjectoptionalstatusone of: fresh, partial, stale, neveroldestSuccessAtstring | nullnewestSuccessAtstring | nullassetsarray of objectincompletearray of string
clarityobjectstatusone of: ready, no_activity, not_connected, stale, partial, failedsyncedAtstring | nullcoverageobjectoptionalfromstring | nulltostring | null
timezoneNotestringmessagestringoptionalfreshnessobjectoptionalstatusone of: fresh, partial, stale, neveroldestSuccessAtstring | nullnewestSuccessAtstring | nullassetsarray of objectincompletearray of string
cardsarray of objectplatformone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritylabelstringhrefstringkpisarray of objectkeystringlabelstringvaluenumber | nullpreviousnumber | nulldeltanumber | nulldirectionone of: up-good, down-good, neutralverdictone of: good, bad, flatformatone of: money, int, pct, ratio, positioncurrencystring | nulloptionalsourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritydefinitionstringvolumeFloornumberoptional
notesarray of stringseriesarray of objectoptionaldatestringvolumenumber | nulloutcomenumber | null
seriesKeysobjectoptionalvolumestringoutcomestring
highlightsobjectoptionaltitlestringsubtitlestringcolumnsarray of objectkeystringlabelstring
rowsarray of objectidstringnamestringdetailstringoptionalhrefstringoptionalthumbnailHrefstring | nulloptionalcellsobject
footnotestringoptional
outcomesarray of objectkeyone of: paid, audience, search, website, commercetitlestringquestionstringentriesarray of objectplatformone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarityprimaryobjectkeystringlabelstringvaluenumber | nullpreviousnumber | nulldeltanumber | nulldirectionone of: up-good, down-good, neutralverdictone of: good, bad, flatformatone of: money, int, pct, ratio, positioncurrencystring | nulloptionalsourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritydefinitionstringvolumeFloornumberoptional
supportingarray of objectkeystringlabelstringvaluenumber | nullpreviousnumber | nulldeltanumber | nulldirectionone of: up-good, down-good, neutralverdictone of: good, bad, flatformatone of: money, int, pct, ratio, positioncurrencystring | nulloptionalsourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritydefinitionstringvolumeFloornumberoptional
hrefstring
missingarray of one of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
moversarray of objectplatformone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritykpiobjectkeystringlabelstringvaluenumber | nullpreviousnumber | nulldeltanumber | nulldirectionone of: up-good, down-good, neutralverdictone of: good, bad, flatformatone of: money, int, pct, ratio, positioncurrencystring | nulloptionalsourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritydefinitionstringvolumeFloornumberoptional
sentimentone of: good, bad, neutralhrefstring
signalsarray of objectentityIdstringentityNamestringlevelone of: campaign, adset, adhrefstringmetricone of: hookRate, holdRate, lpvRate, ctr, cpc, costPerResult, frequency, results, spendmetricLabelstringformatone of: pct, money, int, ratiocurrencystring | nullpreviousnumbercurrentnumberchangePctnumberdirectionone of: up, downsentimentone of: good, bad, neutralscorenumber
attentionarray of objectidstringsourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarityseverityone of: info, warning, criticalcodeone of: low_balance, expired_connection, stale_data, partial_permissions, sync_failed, behaviour_spiketitlestringdetailstringhrefstringoptional
competitorsobjectoptionalwatchednumberchangesTodaynumbertopSeveritynumber | nullhrefstringhighlightsobjecttitlestringsubtitlestringcolumnsarray of objectkeystringlabelstring
rowsarray of objectidstringnamestringdetailstringoptionalhrefstringoptionalthumbnailHrefstring | nulloptionalcellsobject
footnotestringoptional
notesarray of string
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/overview/roster
scope ads:read social:read web:read store:readEvery brand the key covers: connected platforms, each platform’s headline KPI with previous and delta, freshness, health and attention items
Query parameters
| Name | Type | Required |
|---|---|---|
| from | string | yes |
| to | string | yes |
Response 200
{ data, meta } — data is:
fromstringtostringpreviousFromstringpreviousTostringrowsarray of objectclientIdstringnamestringlogoHrefstring | nullplatformsarray of one of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritycellsobjectmetaSpendobjectoptionalkeystringlabelstringvaluenumber | nullpreviousnumber | nulldeltanumber | nulldirectionone of: up-good, down-good, neutralverdictone of: good, bad, flatformatone of: money, int, pct, ratio, positioncurrencystring | nulloptionalsourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritydefinitionstringvolumeFloornumberoptional
metaResultsobjectoptionalkeystringlabelstringvaluenumber | nullpreviousnumber | nulldeltanumber | nulldirectionone of: up-good, down-good, neutralverdictone of: good, bad, flatformatone of: money, int, pct, ratio, positioncurrencystring | nulloptionalsourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritydefinitionstringvolumeFloornumberoptional
gadsSpendobjectoptionalkeystringlabelstringvaluenumber | nullpreviousnumber | nulldeltanumber | nulldirectionone of: up-good, down-good, neutralverdictone of: good, bad, flatformatone of: money, int, pct, ratio, positioncurrencystring | nulloptionalsourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritydefinitionstringvolumeFloornumberoptional
gadsConversionsobjectoptionalkeystringlabelstringvaluenumber | nullpreviousnumber | nulldeltanumber | nulldirectionone of: up-good, down-good, neutralverdictone of: good, bad, flatformatone of: money, int, pct, ratio, positioncurrencystring | nulloptionalsourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritydefinitionstringvolumeFloornumberoptional
igReachobjectoptionalkeystringlabelstringvaluenumber | nullpreviousnumber | nulldeltanumber | nulldirectionone of: up-good, down-good, neutralverdictone of: good, bad, flatformatone of: money, int, pct, ratio, positioncurrencystring | nulloptionalsourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritydefinitionstringvolumeFloornumberoptional
fbInteractionsobjectoptionalkeystringlabelstringvaluenumber | nullpreviousnumber | nulldeltanumber | nulldirectionone of: up-good, down-good, neutralverdictone of: good, bad, flatformatone of: money, int, pct, ratio, positioncurrencystring | nulloptionalsourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritydefinitionstringvolumeFloornumberoptional
ytViewsobjectoptionalkeystringlabelstringvaluenumber | nullpreviousnumber | nulldeltanumber | nulldirectionone of: up-good, down-good, neutralverdictone of: good, bad, flatformatone of: money, int, pct, ratio, positioncurrencystring | nulloptionalsourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritydefinitionstringvolumeFloornumberoptional
ga4Sessionsobjectoptionalkeystringlabelstringvaluenumber | nullpreviousnumber | nulldeltanumber | nulldirectionone of: up-good, down-good, neutralverdictone of: good, bad, flatformatone of: money, int, pct, ratio, positioncurrencystring | nulloptionalsourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritydefinitionstringvolumeFloornumberoptional
gscClicksobjectoptionalkeystringlabelstringvaluenumber | nullpreviousnumber | nulldeltanumber | nulldirectionone of: up-good, down-good, neutralverdictone of: good, bad, flatformatone of: money, int, pct, ratio, positioncurrencystring | nulloptionalsourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritydefinitionstringvolumeFloornumberoptional
shopifyNetSalesobjectoptionalkeystringlabelstringvaluenumber | nullpreviousnumber | nulldeltanumber | nulldirectionone of: up-good, down-good, neutralverdictone of: good, bad, flatformatone of: money, int, pct, ratio, positioncurrencystring | nulloptionalsourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, claritydefinitionstringvolumeFloornumberoptional
freshnessobjectmetastring | nulloptionalgadsstring | nulloptionalinstagramstring | nulloptionalfacebookstring | nulloptionalyoutubestring | nulloptionalga4string | nulloptionalgscstring | nulloptionalshopifystring | nulloptionalclaritystring | nulloptional
healthone of: ok, stale, attentionattentionarray of objectidstringsourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarityseverityone of: info, warning, criticalcodeone of: low_balance, expired_connection, stale_data, partial_permissions, sync_failed, behaviour_spiketitlestringdetailstringhrefstringoptional
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/ads/signals
scope ads:readMeta ads signals: entity movements versus the previous period that are unusual against their siblings (robust z ≥ 3 and ≥ 10%), ranked by score
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | no |
| from | string | yes |
| to | string | yes |
| level | one of: campaign, adset, ad · default ad | no |
| limit | integer · default 50 · min 1 · max 200 | no |
Response 200
{ data, meta } — data is:
fromstringtostringpreviousFromstringpreviousTostringlevelone of: campaign, adset, adcomparedEntitiesnumbersignalsarray of objectentityIdstringentityNamestringlevelone of: campaign, adset, adhrefstringmetricone of: hookRate, holdRate, lpvRate, ctr, cpc, costPerResult, frequency, results, spendmetricLabelstringformatone of: pct, money, int, ratiocurrencystring | nullpreviousnumbercurrentnumberchangePctnumberdirectionone of: up, downsentimentone of: good, bad, neutralscorenumber
truncatedbooleannotesarray of string
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)
/ads/pacing
scope ads:readMonth-to-date Meta budget pacing: spend, resolved month budget and its source, projection, daily paces and an under / on_track / over / unknown status
Query parameters
| Name | Type | Required |
|---|---|---|
| client | string (uuid) | no |
Response 200
{ data, meta } — data is:
pacingobject | nullmonthStartstringmonthEndstringtodaystringdayOfMonthnumberdaysInMonthnumberdaysRemainingnumberfractionnumberspendnumberbudgetnumber | nullbudgetSourceone of: adset-daily, adset-lifetime, account-spend-cap | nullbudgetUsedPctnumber | nullprojectedSpendnumber | nullprojectedVsBudgetPctnumber | nulldailyPaceSoFarnumber | nullidealDailyPacenumber | nullrequiredDailyPacenumber | nullstatusone of: under, on_track, over, unknowncurrencystring | nullaccountCountnumber
notesarray of string
Errors
- 400 Invalid query
- 401 Missing or invalid API key
- 403 Key lacks the required scope
- 404 Not found in this organisation
- 429 Rate limited (60 requests per minute per key)

/social/overview
scope social:readFacebook Page and Instagram totals, comparison period and daily series
Query parameters
Response 200
{ data, meta }—datais:fromstringtostringcompareobject | nullfromstringtostringpreviousFromstring | nullpreviousTostring | nullplatformsarray of objectplatformone of: facebook, instagramtotalsobjectreachnumber | nullimpressionsnumber | nullviewsnumber | nullprofileViewsnumber | nullinteractionsnumber | nullnewFollowsnumber | nullfollowersnumber | nullengagementRatenumber | nullpreviousTotalsobject | nullreachnumber | nullimpressionsnumber | nullviewsnumber | nullprofileViewsnumber | nullinteractionsnumber | nullnewFollowsnumber | nullfollowersnumber | nullengagementRatenumber | nullpostTotalsobjectnewPostsnumberlikesnumber | nullcommentsnumber | nullsharesnumber | nullsavesnumber | nullpreviousPostTotalsobject | nullnewPostsnumberlikesnumber | nullcommentsnumber | nullsharesnumber | nullsavesnumber | nullseriesarray of objectdatestringreachnumber | nullimpressionsnumber | nullviewsnumber | nullinteractionsnumber | nullnewFollowsnumber | nullfollowersnumber | nullpageCountnumberpagesarray of objectpageIdstringnamestringigIdstring | nulloptionaligUsernamestring | nullErrors