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
GET

/me

any scope

The calling key: org, scopes, brand restriction

Query parameters

None.

Response 200

{ data, meta } — data is:

  • keyobject
    • idstring
    • namestring
    • prefixstring
    • expiresAtstring | null
  • orgobject
    • idstring
    • namestring
  • scopesarray of string
  • clientIdsarray 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)
GET

/clients

any scope

Brands (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:

  • idstring
  • namestring
  • adAccountsarray of object
    • idstring
    • platformAccountIdstring
    • namestring
    • currencystring | null
    • lastSyncedAtstring | null
  • pagesarray of object
    • pageIdstring
    • namestring
    • igIdstring | nulloptional
    • igUsernamestring | null
  • analyticsPropertiesarray of object
    • propertyIdstring
    • namestring
    • timezonestring | null
    • lastSyncedAtstring | null
  • searchConsoleSitesarray of object
    • siteUrlstring
    • lastSyncedAtstring | null
  • shopifyStoresarray of object
    • shopDomainstring
    • namestring | null
    • currencystring | null
    • timezonestring | null
    • lastSyncedAtstring | null
  • googleAdsAccountsarray of object
    • customerIdstring
    • namestring
    • currencystring | null
    • timezonestring | null
    • lastSyncedAtstring | null
  • youtubeChannelsarray of object
    • channelIdstring
    • namestring
    • customUrlstring | null
    • subscriberCountnumber | null
    • lastSyncedAtstring | null
  • merchantAccountsarray of object
    • merchantIdstring
    • namestring
    • registrationStatusstring | null
    • lastSyncedAtstring | null
  • competitorsWatchednumber
  • clarityProjectsarray of object
    • labelstring
    • statusstring
    • lastSyncedAtstring | null
  • connectedobject
    • metaAdsboolean
    • facebookboolean
    • instagramboolean
    • googleAnalyticsboolean
    • searchConsoleboolean
    • shopifyboolean
    • googleAdsboolean
    • youtubeboolean
    • merchantCenterboolean
    • competitorsboolean
    • clarityboolean
  • 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)
GET

/ads/overview

scope ads:read

Ads overview: KPIs, comparison period, daily series, funds, widgets

Query parameters

NameTypeRequired
clientstring (uuid)no
fromstringyes
tostringyes
campaignIdstringno
adSetIdstringno
adIdstringno
compareone of: previous, prevMonth, prevYear, none · default previousno

Response 200

{ data, meta } — data is:

  • moneyobject
    • currencystring | null
    • currenciesarray of string
    • mixedboolean
    • unknownnumber
    • byCurrencyarray of object
      • currencystring | null
  • compareobject | null
    • fromstring
    • tostring
  • kpisobject
    • spendnumber | null
    • impressionsnumber
    • reachnumber
    • clicksnumber
    • ctrnumber
    • cpcnumber | null
    • videoViewsnumber
    • purchaseValuenumber | null
    • resultsnumber
    • resultTypestring | null
    • costPerResultnumber | null
  • previousobject | null
    • spendnumber | null
    • resultsnumber
    • impressionsnumber
    • clicksnumber
    • reachnumber
  • fundsobject
    • balancenumber | null
    • spentnumber | null
    • capnumber | null
    • byCurrencyarray of objectoptional
      • currencystring | null
      • remainingLimitnumber | null
      • prepaidFundsnumber | null
      • owednumber | null
      • spentnumber | null
    • updatedAtstring | nulloptional
  • lowBalancearray of object
    • accountNamestring
    • balancenumber
    • thresholdnumber
    • currencystring | null
  • seriesarray of object
    • datestring
    • spendnumber | null
    • impressionsnumber
    • clicksnumber
    • reachnumber
    • resultsnumber
  • campaignsarray of object
    • idstring
    • namestring
    • statusstring | null
    • effectiveStatusstring | null
    • currencystring | null
    • spendnumber
    • impressionsnumber
    • clicksnumber
    • ctrnumber
    • accountobject | null
      • idstring
      • platformAccountIdstring
      • namestring
    • clientobject | null
      • idstring | null
      • namestring
  • widgetsobject
    • funnelobject
      • impressionsnumber
      • reachnumber
      • clicksnumber
      • linkClicksnumber
      • resultsnumber
      • resultTypestring | null
    • topCampaignsarray of object
      • platformIdstring
      • namestring
      • spendnumber
      • resultsnumber | null
      • resultTypestring | null
      • costPerResultnumber | null
      • ctrnumber
      • statusstring | null
    • ageGenderarray of object
      • agestring
      • genderstring
      • impressionsnumber
      • clicksnumber
      • spendnumber | null
      • reachnumber
    • platformsarray of object
      • platformstring
      • impressionsnumber
      • spendnumber | null
      • clicksnumber
    • placementsarray of object
      • platformstring
      • positionstring
      • impressionsnumber
      • spendnumber | null
      • clicksnumber
    • videoobject
      • views3snumber
      • thruplaynumber
      • p25number
      • p50number
      • p75number
      • p100number

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)
GET

/ads/entities

scope ads:read

Campaigns, ad sets or ads with range totals, ordered by sort/dir (capped at 500; see meta.truncated)

Query parameters

NameTypeRequired
levelone of: campaign, adset, adyes
clientstring (uuid)no
fromstringyes
tostringyes
searchstringno
sortone of: spend, impressions, reach, clicks, results, ctr, cpc, costPerResult, frequency, name, delivery · default spendno
dirone of: asc, desc · default descno

Response 200

{ data, meta } — data is:

  • rowsarray of object
    • idstring
    • platformIdstring
    • namestring
    • statusstring | null
    • effectiveStatusstring | null
    • currencystring | null
    • spendnumber
    • impressionsnumber
    • reachnumber
    • clicksnumber
    • linkClicksnumber
    • resultsnumber | null
    • resultTypestring | null
    • ctrnumber | null
    • cpcnumber | null
    • costPerResultnumber | null
    • frequencynumber | null
    • thumbnailUrlstring | nulloptional
    • imageUrlstring | nulloptional
    • accountobject | null
      • idstring
      • platformAccountIdstring
      • namestring
    • clientobject | null
      • idstring | null
      • namestring
    • campaignobject | null
      • idstring
      • platformIdstring
      • namestring
      • objectivestring | null
    • adSetobject | null
      • idstring
      • platformIdstring
      • namestring
  • 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)
GET

/ads/breakdowns

scope ads:read

Age/gender, device, platform, placement and region for one entity (cached data only; see stale)

Query parameters

NameTypeRequired
levelone of: campaign, adset, adyes
entityIdstringyes
fromstringyes
tostringyes

Response 200

{ data, meta } — data is:

  • ageGenderarray of object
    • key1string
    • key2string
    • spendnumber
    • impressionsnumber
    • clicksnumber
    • reachnumber
  • devicearray of object
    • key1string
    • key2string
    • spendnumber
    • impressionsnumber
    • clicksnumber
    • reachnumber
  • platformarray of object
    • key1string
    • key2string
    • spendnumber
    • impressionsnumber
    • clicksnumber
    • reachnumber
  • placementarray of object
    • key1string
    • key2string
    • spendnumber
    • impressionsnumber
    • clicksnumber
    • reachnumber
  • regionarray of object
    • key1string
    • key2string
    • spendnumber
    • impressionsnumber
    • clicksnumber
    • reachnumber
  • syncedAtstring | null
  • staleboolean

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)
GET

/social/overview

scope social:read

Facebook Page and Instagram totals, comparison period and daily series

Query parameters

NameTypeRequired
clientstring (uuid)no
fromstringyes
tostringyes
compareone of: previous, prevMonth, prevYear, none · default previousno

Response 200

{ data, meta } — data is:

  • fromstring
  • tostring
  • compareobject | null
    • fromstring
    • tostring
  • previousFromstring | null
  • previousTostring | null
  • platformsarray of object
    • platformone of: facebook, instagram
    • totalsobject
      • reachnumber | null
      • impressionsnumber | null
      • viewsnumber | null
      • profileViewsnumber | null
      • interactionsnumber | null
      • newFollowsnumber | null
      • followersnumber | null
      • engagementRatenumber | null
    • previousTotalsobject | null
      • reachnumber | null
      • impressionsnumber | null
      • viewsnumber | null
      • profileViewsnumber | null
      • interactionsnumber | null
      • newFollowsnumber | null
      • followersnumber | null
      • engagementRatenumber | null
    • postTotalsobject
      • newPostsnumber
      • likesnumber | null
      • commentsnumber | null
      • sharesnumber | null
      • savesnumber | null
    • previousPostTotalsobject | null
      • newPostsnumber
      • likesnumber | null
      • commentsnumber | null
      • sharesnumber | null
      • savesnumber | null
    • seriesarray of object
      • datestring
      • reachnumber | null
      • impressionsnumber | null
      • viewsnumber | null
      • interactionsnumber | null
      • newFollowsnumber | null
      • followersnumber | null
    • pageCountnumber
  • pagesarray of object
    • pageIdstring
    • namestring
    • igIdstring | nulloptional
    • igUsernamestring | 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)
GET

/social/posts

scope social:read

Posts published in the range with per-post metrics (newest first)

Query parameters

NameTypeRequired
clientstring (uuid)no
fromstringyes
tostringyes
limitinteger · default 100 · min 1 · max 500no

Response 200

{ data, meta } — data is:

  • postsarray of object
    • idstring
    • platformone of: facebook, instagram
    • postIdstring
    • captionstring | null
    • mediaTypestring | null
    • permalinkstring | null
    • thumbnailHrefstring | null
    • publishedAtstring
    • likesnumber | null
    • commentsnumber | null
    • sharesnumber | null
    • savesnumber | null
    • viewsnumber | null
    • reachnumber | null
    • impressionsnumber | null
    • engagementRatenumber | null
  • 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)
GET

/website/overview

scope web:read

Google Analytics: totals, previous period, daily series and the channel, source, landing page, event, device and country tables

Query parameters

NameTypeRequired
clientstring (uuid)no
fromstringyes
tostringyes
compareone of: previous, prevMonth, prevYear, none · default previousno
limitinteger · default 25 · min 1 · max 100no

Response 200

{ data, meta } — data is:

  • fromstring
  • tostring
  • compareobject | null
    • fromstring
    • tostring
  • analyticsobject | null
    • propertiesarray of object
      • idstring
      • namestring
      • timezonestring | null
      • lastSyncedAtstring | null
    • currencystring | null
    • moneyobject
      • currencystring | null
      • currenciesarray of string
      • mixedboolean
      • unknownnumber
      • byCurrencyarray of object
        • currencystring | null
    • totalsobject
      • sessionsnumber | null
      • totalUsersnumber | null
      • activeUsersnumber | null
      • newUsersnumber | null
      • engagedSessionsnumber | null
      • screenPageViewsnumber | null
      • eventCountnumber | null
      • keyEventsnumber | null
      • totalRevenuenumber | null
      • purchaseRevenuenumber | null
      • transactionsnumber | null
      • ecommercePurchasesnumber | null
      • userEngagementDurationnumber | null
      • sessionDurationWeightednumber | null
      • engagementRatenumber | null
      • bounceRatenumber | null
      • averageSessionDurationnumber | null
      • sessionsPerUsernumber | null
      • screenPageViewsPerSessionnumber | null
      • eventCountPerUsernumber | null
      • conversionRatenumber | null
      • revenuePerSessionnumber | null
    • previousobject | null
      • sessionsnumber | null
      • totalUsersnumber | null
      • activeUsersnumber | null
      • newUsersnumber | null
      • engagedSessionsnumber | null
      • screenPageViewsnumber | null
      • eventCountnumber | null
      • keyEventsnumber | null
      • totalRevenuenumber | null
      • purchaseRevenuenumber | null
      • transactionsnumber | null
      • ecommercePurchasesnumber | null
      • userEngagementDurationnumber | null
      • sessionDurationWeightednumber | null
      • engagementRatenumber | null
      • bounceRatenumber | null
      • averageSessionDurationnumber | null
      • sessionsPerUsernumber | null
      • screenPageViewsPerSessionnumber | null
      • eventCountPerUsernumber | null
      • conversionRatenumber | null
      • revenuePerSessionnumber | null
    • seriesarray of object
      • datestring
      • sessionsnumber | null
      • totalUsersnumber | null
      • newUsersnumber | null
      • engagedSessionsnumber | null
      • keyEventsnumber | null
      • totalRevenuenumber | null
    • previousSeriesarray of object
      • datestring
      • sessionsnumber | null
      • totalUsersnumber | null
      • newUsersnumber | null
      • engagedSessionsnumber | null
      • keyEventsnumber | null
      • totalRevenuenumber | null
    • channelsarray of object
      • keystring
      • labelstring
      • detailstringoptional
      • totalsobject
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
      • previousobject | null
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
    • sourcesarray of object
      • keystring
      • labelstring
      • detailstringoptional
      • totalsobject
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
      • previousobject | null
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
    • landingPagesarray of object
      • keystring
      • labelstring
      • detailstringoptional
      • totalsobject
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
      • previousobject | null
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
    • organicLandingPagesarray of object
      • keystring
      • labelstring
      • detailstringoptional
      • totalsobject
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
      • previousobject | null
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
    • pagesarray of object
      • keystring
      • labelstring
      • detailstringoptional
      • totalsobject
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
      • previousobject | null
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
    • eventsarray of object
      • keystring
      • labelstring
      • detailstringoptional
      • totalsobject
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
      • previousobject | null
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
    • devicesarray of object
      • keystring
      • labelstring
      • detailstringoptional
      • totalsobject
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
      • previousobject | null
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
    • countriesarray of object
      • keystring
      • labelstring
      • detailstringoptional
      • totalsobject
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
      • previousobject | null
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
    • newReturningarray of object
      • keystring
      • labelstring
      • detailstringoptional
      • totalsobject
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | null
      • previousobject | null
        • sessionsnumber | null
        • totalUsersnumber | null
        • activeUsersnumber | null
        • newUsersnumber | null
        • engagedSessionsnumber | null
        • screenPageViewsnumber | null
        • eventCountnumber | null
        • keyEventsnumber | null
        • totalRevenuenumber | null
        • purchaseRevenuenumber | null
        • transactionsnumber | null
        • ecommercePurchasesnumber | null
        • userEngagementDurationnumber | null
        • sessionDurationWeightednumber | null
        • engagementRatenumber | null
        • bounceRatenumber | null
        • averageSessionDurationnumber | null
        • sessionsPerUsernumber | null
        • screenPageViewsPerSessionnumber | null
        • eventCountPerUsernumber | null
        • conversionRatenumber | null
        • revenuePerSessionnumber | 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)
GET

/website/behaviour

scope web:read

Microsoft 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

NameTypeRequired
clientstring (uuid)no
fromstringyes
tostringyes
compareone of: previous, prevMonth, prevYear, none · default previousno
limitinteger · default 25 · min 1 · max 100no

Response 200

{ data, meta } — data is:

  • connectedboolean
  • projectsarray of object
    • clientIdstring
    • labelstring
    • statusstring
    • connectedAtstring
    • lastSyncedAtstring | null
    • dashboardUrlstring | null
  • historyStartsOnstring | null
  • totalsobject | null
    • sessionsnumber | null
    • botSessionsnumber | null
    • usersnumber | null
    • pagesPerSessionnumber | null
    • scrollDepthnumber | null
    • totalTimenumber | null
    • activeTimenumber | null
    • deadClicksnumber | null
    • deadClickRatenumber | null
    • rageClicksnumber | null
    • rageClickRatenumber | null
    • excessiveScrollsnumber | null
    • excessiveScrollRatenumber | null
    • quickbacksnumber | null
    • quickbackRatenumber | null
    • scriptErrorsnumber | null
    • scriptErrorRatenumber | null
    • errorClicksnumber | null
    • errorClickRatenumber | null
  • previousobject | null
    • sessionsnumber | null
    • botSessionsnumber | null
    • usersnumber | null
    • pagesPerSessionnumber | null
    • scrollDepthnumber | null
    • totalTimenumber | null
    • activeTimenumber | null
    • deadClicksnumber | null
    • deadClickRatenumber | null
    • rageClicksnumber | null
    • rageClickRatenumber | null
    • excessiveScrollsnumber | null
    • excessiveScrollRatenumber | null
    • quickbacksnumber | null
    • quickbackRatenumber | null
    • scriptErrorsnumber | null
    • scriptErrorRatenumber | null
    • errorClicksnumber | null
    • errorClickRatenumber | null
  • compareobject | null
    • fromstring
    • tostring
  • seriesarray of object
    • sessionsnumber | null
    • botSessionsnumber | null
    • usersnumber | null
    • pagesPerSessionnumber | null
    • scrollDepthnumber | null
    • totalTimenumber | null
    • activeTimenumber | null
    • deadClicksnumber | null
    • deadClickRatenumber | null
    • rageClicksnumber | null
    • rageClickRatenumber | null
    • excessiveScrollsnumber | null
    • excessiveScrollRatenumber | null
    • quickbacksnumber | null
    • quickbackRatenumber | null
    • scriptErrorsnumber | null
    • scriptErrorRatenumber | null
    • errorClicksnumber | null
    • errorClickRatenumber | null
    • datestring
  • previousSeriesarray of object
    • sessionsnumber | null
    • botSessionsnumber | null
    • usersnumber | null
    • pagesPerSessionnumber | null
    • scrollDepthnumber | null
    • totalTimenumber | null
    • activeTimenumber | null
    • deadClicksnumber | null
    • deadClickRatenumber | null
    • rageClicksnumber | null
    • rageClickRatenumber | null
    • excessiveScrollsnumber | null
    • excessiveScrollRatenumber | null
    • quickbacksnumber | null
    • quickbackRatenumber | null
    • scriptErrorsnumber | null
    • scriptErrorRatenumber | null
    • errorClicksnumber | null
    • errorClickRatenumber | null
    • datestring
  • topFrustrationPagesarray of object
    • urlstring
    • sessionsnumber | null
    • rageClickRatenumber | null
    • deadClickRatenumber | null
    • quickbackRatenumber | null
    • scriptErrorsnumber | null
    • scriptErrorRatenumber | null
    • clarityUrlstring | null
  • devicesarray of object
    • labelstring
    • sessionsnumber | null
    • rageClickRatenumber | null
    • deadClickRatenumber | null
    • quickbackRatenumber | null
    • scriptErrorRatenumber | null
  • countriesarray of object
    • labelstring
    • sessionsnumber | null
    • rageClickRatenumber | null
    • deadClickRatenumber | null
    • quickbackRatenumber | null
    • scriptErrorRatenumber | null
  • browsersarray of object
    • labelstring
    • sessionsnumber | null
    • rageClickRatenumber | null
    • deadClickRatenumber | null
    • quickbackRatenumber | null
    • scriptErrorRatenumber | null
  • operatingSystemsarray of object
    • labelstring
    • sessionsnumber | null
    • rageClickRatenumber | null
    • deadClickRatenumber | null
    • quickbackRatenumber | null
    • scriptErrorRatenumber | null
  • sourcesarray of object
    • labelstring
    • sessionsnumber | null
    • rageClickRatenumber | null
    • deadClickRatenumber | null
    • quickbackRatenumber | null
    • scriptErrorRatenumber | null
  • channelsarray of object
    • labelstring
    • sessionsnumber | null
    • rageClickRatenumber | null
    • deadClickRatenumber | null
    • quickbackRatenumber | null
    • scriptErrorRatenumber | 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)
GET

/store/overview

scope store:read

Shopify: sales ladder, orders, customers, AOV, daily series and the product, channel, referrer, country and discount tables

Query parameters

NameTypeRequired
clientstring (uuid)no
fromstringyes
tostringyes
compareone of: previous, prevMonth, prevYear, none · default previousno
limitinteger · default 25 · min 1 · max 100no

Response 200

{ data, meta } — data is:

  • fromstring
  • tostring
  • compareobject | null
    • fromstring
    • tostring
  • storeobject | null
    • storesarray of object
      • idstring
      • shopDomainstring
      • shopNamestring | null
      • timezonestring | null
      • lastSyncedAtstring | null
      • hasAllOrdersScopeboolean
    • currencystring | null
    • moneyobject
      • currencystring | null
      • currenciesarray of string
      • mixedboolean
      • unknownnumber
      • byCurrencyarray of object
        • currencystring | null
    • totalsobject
      • grossSalesnumber | null
      • discountsnumber | null
      • returnsnumber | null
      • netSalesnumber | null
      • shippingnumber | null
      • taxesnumber | null
      • dutiesnumber | null
      • tipsnumber | null
      • totalSalesnumber | null
      • ordersnumber | null
      • cancelledOrdersnumber | null
      • refundedOrdersnumber | null
      • unitsSoldnumber | null
      • customersnumber | null
      • newCustomersnumber | null
      • returningCustomersnumber | null
      • averageOrderValuenumber | null
      • averageUnitsPerOrdernumber | null
      • returnRatenumber | null
      • discountRatenumber | null
      • newCustomerRatenumber | null
      • revenuePerCustomernumber | null
    • previousobject | null
      • grossSalesnumber | null
      • discountsnumber | null
      • returnsnumber | null
      • netSalesnumber | null
      • shippingnumber | null
      • taxesnumber | null
      • dutiesnumber | null
      • tipsnumber | null
      • totalSalesnumber | null
      • ordersnumber | null
      • cancelledOrdersnumber | null
      • refundedOrdersnumber | null
      • unitsSoldnumber | null
      • customersnumber | null
      • newCustomersnumber | null
      • returningCustomersnumber | null
      • averageOrderValuenumber | null
      • averageUnitsPerOrdernumber | null
      • returnRatenumber | null
      • discountRatenumber | null
      • newCustomerRatenumber | null
      • revenuePerCustomernumber | null
    • seriesarray of object
      • datestring
      • netSalesnumber | null
      • grossSalesnumber | null
      • ordersnumber | null
      • unitsSoldnumber | null
      • returnsnumber | null
      • newCustomersnumber | null
    • previousSeriesarray of object
      • datestring
      • netSalesnumber | null
      • grossSalesnumber | null
      • ordersnumber | null
      • unitsSoldnumber | null
      • returnsnumber | null
      • newCustomersnumber | null
    • productsarray of object
      • keystring
      • labelstring
      • detailstringoptional
      • imagestringoptional
      • totalsobject
        • grossSalesnumber | null
        • discountsnumber | null
        • returnsnumber | null
        • netSalesnumber | null
        • shippingnumber | null
        • taxesnumber | null
        • dutiesnumber | null
        • tipsnumber | null
        • totalSalesnumber | null
        • ordersnumber | null
        • cancelledOrdersnumber | null
        • refundedOrdersnumber | null
        • unitsSoldnumber | null
        • customersnumber | null
        • newCustomersnumber | null
        • returningCustomersnumber | null
        • averageOrderValuenumber | null
        • averageUnitsPerOrdernumber | null
        • returnRatenumber | null
        • discountRatenumber | null
        • newCustomerRatenumber | null
        • revenuePerCustomernumber | null
      • previousobject | null
        • grossSalesnumber | null
        • discountsnumber | null
        • returnsnumber | null
        • netSalesnumber | null
        • shippingnumber | null
        • taxesnumber | null
        • dutiesnumber | null
        • tipsnumber | null
        • totalSalesnumber | null
        • ordersnumber | null
        • cancelledOrdersnumber | null
        • refundedOrdersnumber | null
        • unitsSoldnumber | null
        • customersnumber | null
        • newCustomersnumber | null
        • returningCustomersnumber | null
        • averageOrderValuenumber | null
        • averageUnitsPerOrdernumber | null
        • returnRatenumber | null
        • discountRatenumber | null
        • newCustomerRatenumber | null
        • revenuePerCustomernumber | null
    • channelsarray of object
      • keystring
      • labelstring
      • detailstringoptional
      • imagestringoptional
      • totalsobject
        • grossSalesnumber | null
        • discountsnumber | null
        • returnsnumber | null
        • netSalesnumber | null
        • shippingnumber | null
        • taxesnumber | null
        • dutiesnumber | null
        • tipsnumber | null
        • totalSalesnumber | null
        • ordersnumber | null
        • cancelledOrdersnumber | null
        • refundedOrdersnumber | null
        • unitsSoldnumber | null
        • customersnumber | null
        • newCustomersnumber | null
        • returningCustomersnumber | null
        • averageOrderValuenumber | null
        • averageUnitsPerOrdernumber | null
        • returnRatenumber | null
        • discountRatenumber | null
        • newCustomerRatenumber | null
        • revenuePerCustomernumber | null
      • previousobject | null
        • grossSalesnumber | null
        • discountsnumber | null
        • returnsnumber | null
        • netSalesnumber | null
        • shippingnumber | null
        • taxesnumber | null
        • dutiesnumber | null
        • tipsnumber | null
        • totalSalesnumber | null
        • ordersnumber | null
        • cancelledOrdersnumber | null
        • refundedOrdersnumber | null
        • unitsSoldnumber | null
        • customersnumber | null
        • newCustomersnumber | null
        • returningCustomersnumber | null
        • averageOrderValuenumber | null
        • averageUnitsPerOrdernumber | null
        • returnRatenumber | null
        • discountRatenumber | null
        • newCustomerRatenumber | null
        • revenuePerCustomernumber | null
    • referrersarray of object
      • keystring
      • labelstring
      • detailstringoptional
      • imagestringoptional
      • totalsobject
        • grossSalesnumber | null
        • discountsnumber | null
        • returnsnumber | null
        • netSalesnumber | null
        • shippingnumber | null
        • taxesnumber | null
        • dutiesnumber | null
        • tipsnumber | null
        • totalSalesnumber | null
        • ordersnumber | null
        • cancelledOrdersnumber | null
        • refundedOrdersnumber | null
        • unitsSoldnumber | null
        • customersnumber | null
        • newCustomersnumber | null
        • returningCustomersnumber | null
        • averageOrderValuenumber | null
        • averageUnitsPerOrdernumber | null
        • returnRatenumber | null
        • discountRatenumber | null
        • newCustomerRatenumber | null
        • revenuePerCustomernumber | null
      • previousobject | null
        • grossSalesnumber | null
        • discountsnumber | null
        • returnsnumber | null
        • netSalesnumber | null
        • shippingnumber | null
        • taxesnumber | null
        • dutiesnumber | null
        • tipsnumber | null
        • totalSalesnumber | null
        • ordersnumber | null
        • cancelledOrdersnumber | null
        • refundedOrdersnumber | null
        • unitsSoldnumber | null
        • customersnumber | null
        • newCustomersnumber | null
        • returningCustomersnumber | null
        • averageOrderValuenumber | null
        • averageUnitsPerOrdernumber | null
        • returnRatenumber | null
        • discountRatenumber | null
        • newCustomerRatenumber | null
        • revenuePerCustomernumber | null
    • countriesarray of object
      • keystring
      • labelstring
      • detailstringoptional
      • imagestringoptional
      • totalsobject
        • grossSalesnumber | null
        • discountsnumber | null
        • returnsnumber | null
        • netSalesnumber | null
        • shippingnumber | null
        • taxesnumber | null
        • dutiesnumber | null
        • tipsnumber | null
        • totalSalesnumber | null
        • ordersnumber | null
        • cancelledOrdersnumber | null
        • refundedOrdersnumber | null
        • unitsSoldnumber | null
        • customersnumber | null
        • newCustomersnumber | null
        • returningCustomersnumber | null
        • averageOrderValuenumber | null
        • averageUnitsPerOrdernumber | null
        • returnRatenumber | null
        • discountRatenumber | null
        • newCustomerRatenumber | null
        • revenuePerCustomernumber | null
      • previousobject | null
        • grossSalesnumber | null
        • discountsnumber | null
        • returnsnumber | null
        • netSalesnumber | null
        • shippingnumber | null
        • taxesnumber | null
        • dutiesnumber | null
        • tipsnumber | null
        • totalSalesnumber | null
        • ordersnumber | null
        • cancelledOrdersnumber | null
        • refundedOrdersnumber | null
        • unitsSoldnumber | null
        • customersnumber | null
        • newCustomersnumber | null
        • returningCustomersnumber | null
        • averageOrderValuenumber | null
        • averageUnitsPerOrdernumber | null
        • returnRatenumber | null
        • discountRatenumber | null
        • newCustomerRatenumber | null
        • revenuePerCustomernumber | null
    • discountsarray of object
      • keystring
      • labelstring
      • detailstringoptional
      • imagestringoptional
      • totalsobject
        • grossSalesnumber | null
        • discountsnumber | null
        • returnsnumber | null
        • netSalesnumber | null
        • shippingnumber | null
        • taxesnumber | null
        • dutiesnumber | null
        • tipsnumber | null
        • totalSalesnumber | null
        • ordersnumber | null
        • cancelledOrdersnumber | null
        • refundedOrdersnumber | null
        • unitsSoldnumber | null
        • customersnumber | null
        • newCustomersnumber | null
        • returningCustomersnumber | null
        • averageOrderValuenumber | null
        • averageUnitsPerOrdernumber | null
        • returnRatenumber | null
        • discountRatenumber | null
        • newCustomerRatenumber | null
        • revenuePerCustomernumber | null
      • previousobject | null
        • grossSalesnumber | null
        • discountsnumber | null
        • returnsnumber | null
        • netSalesnumber | null
        • shippingnumber | null
        • taxesnumber | null
        • dutiesnumber | null
        • tipsnumber | null
        • totalSalesnumber | null
        • ordersnumber | null
        • cancelledOrdersnumber | null
        • refundedOrdersnumber | null
        • unitsSoldnumber | null
        • customersnumber | null
        • newCustomersnumber | null
        • returningCustomersnumber | null
        • averageOrderValuenumber | null
        • averageUnitsPerOrdernumber | null
        • returnRatenumber | null
        • discountRatenumber | null
        • newCustomerRatenumber | null
        • revenuePerCustomernumber | 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)
GET

/youtube/overview

scope social:read

YouTube: views, watch minutes, average view duration, subscribers, daily series, top videos, traffic sources, devices and countries

Query parameters

NameTypeRequired
clientstring (uuid)no
fromstringyes
tostringyes
compareone of: previous, prevMonth, prevYear, none · default previousno
limitinteger · default 25 · min 1 · max 100no

Response 200

{ data, meta } — data is:

  • fromstring
  • tostring
  • compareobject | null
    • fromstring
    • tostring
  • youtubeobject | null
    • channelsarray of object
      • idstring
      • channelIdstring
      • titlestring
      • customUrlstring | null
      • subscriberCountnumber | null
      • lastSyncedAtstring | null
    • totalsobject
      • viewsnumber | null
      • estimatedMinutesWatchednumber | null
      • subscribersGainednumber | null
      • subscribersLostnumber | null
      • likesnumber | null
      • commentsnumber | null
      • sharesnumber | null
      • averageViewDurationSecondsnumber | null
      • netSubscribersnumber | null
      • engagementsnumber | null
    • previousobject | null
      • viewsnumber | null
      • estimatedMinutesWatchednumber | null
      • subscribersGainednumber | null
      • subscribersLostnumber | null
      • likesnumber | null
      • commentsnumber | null
      • sharesnumber | null
      • averageViewDurationSecondsnumber | null
      • netSubscribersnumber | null
      • engagementsnumber | null
    • seriesarray of object
      • datestring
      • viewsnumber | null
      • minutesWatchednumber | null
      • netSubscribersnumber | null
    • previousSeriesarray of object
      • datestring
      • viewsnumber | null
      • minutesWatchednumber | null
      • netSubscribersnumber | null
    • videosarray of object
      • idstring
      • videoIdstring
      • titlestring
      • publishedAtstring | null
      • durationSecondsnumber | null
      • watchUrlstring
      • thumbnailUrlstring
      • totalsobject
        • viewsnumber | null
        • minutesWatchednumber | null
        • likesnumber | null
        • commentsnumber | null
        • sharesnumber | null
      • previousobject | null
        • viewsnumber | null
        • minutesWatchednumber | null
        • likesnumber | null
        • commentsnumber | null
        • sharesnumber | null
    • trafficSourcesarray of object
      • keystring
      • labelstring
      • totalsobject
        • viewsnumber | null
        • minutesWatchednumber | null
      • previousobject | null
        • viewsnumber | null
        • minutesWatchednumber | null
    • devicesarray of object
      • keystring
      • labelstring
      • totalsobject
        • viewsnumber | null
        • minutesWatchednumber | null
      • previousobject | null
        • viewsnumber | null
        • minutesWatchednumber | null
    • countriesarray of object
      • keystring
      • labelstring
      • totalsobject
        • viewsnumber | null
        • minutesWatchednumber | null
      • previousobject | null
        • viewsnumber | null
        • minutesWatchednumber | 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)
GET

/competitors

scope competitors:read

Competitor websites each brand watches, with status, logo, last check, products tracked and each site’s check state over `days`

Query parameters

NameTypeRequired
clientstring (uuid)no
daysinteger · default 1 · min 1 · max 90no

Response 200

{ data, meta } — data is:

  • competitorsarray of object
    • idstring
    • clientobject
      • idstring
      • namestring
    • namestring
    • hoststring
    • siteUrlstring
    • platformstring
    • statusstring
    • lastCheckAtstring | null
    • nextCheckAtstring | null
    • productsTrackednumber
    • logoUrlstring | null
    • checkobject
      • competitorIdstring
      • stateone of: changed, checked_no_changes, partial, failed, stale, paused, unsupported, pending
      • lastAttemptAtstring | null
      • lastAttemptStatusstring | null
      • lastSuccessAtstring | null
      • partialboolean
      • staleboolean
      • changeGroupsInWindownumber
      • changeEventsInWindownumber
    • windowobject
      • kindone of: rolling, ist_days
      • daysnumber
      • fromstring
      • tostring
      • fromDaystring
    • scopeobjectoptional
      • modeone of: whole_site, selected
      • sitewideboolean
      • itemsarray of object
        • kindone of: collection, path_prefix
        • keystring
        • labelstring
        • missingboolean

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)
GET

/competitors/changes

scope competitors:read

Grouped 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

NameTypeRequired
clientstring (uuid)no
competitorstring (uuid)no
fromstringyes
tostringyes
minSeverityinteger · default 1 · min 1 · max 5no
limitinteger · default 50 · min 1 · max 200no
cursorstringno
groupstringno

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)
GET

/competitors/insights

scope competitors:read

Rule-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

NameTypeRequired
clientstring (uuid)no
daysinteger · default 1 · min 1 · max 90no

Response 200

{ data, meta } — data is:

  • insightsarray of object
    • kindstring
    • competitorIdstring | null
    • competitorNamestring | null
    • figurestring
    • unitstring
    • sentencestring
    • imageUrlsarray of string
  • competitorsWatchednumber
  • competitorsarray of object
    • idstring
    • clientIdstring
    • namestring
    • logoUrlstring | null
  • bannersTotalnumber
  • bannersLiveBySiteobject
  • sitesarray of object
    • competitorIdstring
    • stateone of: changed, checked_no_changes, partial, failed, stale, paused, unsupported, pending
    • lastAttemptAtstring | null
    • lastAttemptStatusstring | null
    • lastSuccessAtstring | null
    • partialboolean
    • staleboolean
    • changeGroupsInWindownumber
    • changeEventsInWindownumber
  • windowobject
    • kindone of: rolling, ist_days
    • daysnumber
    • fromstring
    • tostring
    • fromDaystring

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)
GET

/competitors/detail

scope competitors:read

One 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

NameTypeRequired
competitorstring (uuid)yes
datasetone of: products, banners, seo, runs, price_historyno
cursorstringno
limitinteger · min 1 · max 500no

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)
GET

/addons/gokwik

scope store:read

GoKwik checkout add-on for one brand: KPIs, funnel, payment mix, coupons, UTM sources and campaigns, cities, states and a daily series

Query parameters

NameTypeRequired
clientstring (uuid)yes
fromstringno
tostringno

Response 200

{ data, meta } — data is:

  • clientobject
    • idstring
    • namestring
  • currencystring | null
  • moneyobject
    • currencystring | null
    • currenciesarray of string
    • mixedboolean
    • unknownnumber
    • byCurrencyarray of object
      • currencystring | null
  • dataKindstring
  • eventCountnumber
  • lastEventReceivedAtstring | null
  • reconciliationobject | null
    • shopifyOrdersnumber
    • shopifyNetSalesnumber | null
    • currencystring | null
    • differenceobject
      • ordersnumber
      • revenuenumber | null
  • provenanceobject
    • offStoreOriginEventsnumber
    • unknownOriginEventsnumber
    • originHostsarray of object
      • hoststring
      • eventsnumber
      • expectedboolean
    • droppedEventsnumber
    • droppedByReasonarray of object
      • reasonstring
      • countnumber
  • kpisobject
    • checkoutsStartednumber
    • ordersPlacednumber
    • conversionRatenumber | null
    • revenuenumber | null
    • averageOrderValuenumber | null
    • codSharenumber | null
    • unmatchedOrdersnumberoptional
    • ordersWithAmountnumberoptional
    • ordersWithPaymentMethodnumberoptional
  • funnelarray of object
    • stepstring
    • labelstring
    • countnumber
    • stepConversionnumber | null
    • dropOffnumber | null
    • notestring | nulloptional
  • paymentMethodsarray of object
    • methodstring
    • ordersnumber
  • couponsarray of object
    • codestring
    • appliednumber
    • failednumber
    • discountGivennumber
  • utmSourcesarray of object
    • sourcestring
    • checkoutsStartednumber
    • ordersPlacednumber
  • utmCampaignsarray of object
    • campaignstring
    • checkoutsStartednumber
    • ordersPlacednumber
  • citiesarray of object
    • citystring
    • ordersnumber
  • statesarray of object
    • statestring
    • ordersnumber
  • dailyarray of object
    • datestring
    • checkoutsStartednumber
    • ordersPlacednumber
  • 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)
GET

/addons/zoho-books

scope finance:read

Zoho 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

NameTypeRequired
clientstring (uuid)yes
fromstringno
tostringno
orgstringno

Response 200

{ data, meta } — data is:

  • clientobject
    • idstring
    • namestring
  • currencystring
  • connectionobject | null
    • statusstring
    • statusReasonstring | null
    • lastSyncedAtstring | null
  • organizationsarray of object
    • idstring
    • namestring
  • orgstring
  • booksobject | null
    • asOfstring
    • kpisobject
      • salesnumber
      • invoiceCountnumber
      • collectionsnumber
      • lastPaymentDatestring | null
      • outstandingnumber
      • overduenumber
      • expensesnumber
      • grossProfitnumber | null
      • grossProfitMonthsarray of string
      • salesOrdersnumber
      • salesOrderValuenumber
    • monthlyTrendarray of object
      • monthstring
      • salesnumber
      • collectionsnumber
      • expensesnumber
    • receivablesAgingarray of object
      • bucketstring
      • balancenumber
      • invoicesnumber
    • topCustomersByOutstandingarray of object
      • customerstring
      • balancenumber
      • overduenumber
      • invoicesnumber
    • topCustomersBySalesarray of object
      • customerstring
      • salesnumber
      • invoicesnumber
    • pnlByMontharray of object
      • monthstring
      • salesnumber | null
      • cogsnumber | null
      • grossProfitnumber | null
      • operatingExpensenumber | null
      • operatingProfitnumber | null
      • netProfitnumber | null
    • payablesobject
      • openBalancenumber
      • overduenumber
      • openBillsnumber
      • vendorsarray of object
        • vendorstring
        • balancenumber
        • billsnumber
  • 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)
GET

/shopping

scope store:read

Google 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

NameTypeRequired
clientstring (uuid)yes
fromstringno
tostringno

Response 200

{ data, meta } — data is:

  • clientobject
    • idstring
    • namestring
  • connectedboolean
  • currencystring | null
  • accountsarray of object
    • idstring
    • merchantIdstring
    • namestring
    • lastSyncedAtstring | null
    • registrationStatusstring | null
    • priceCompetitivenessAvailableboolean | null
  • catalogueobject
    • productsnumber
    • approvednumber
    • limitednumber
    • pendingnumber
    • disapprovednumber
    • productsWithIssuesnumber
    • issuesBySeverityarray of object
      • severitystring
      • productsnumber
  • topIssuesarray of object
    • codestring
    • descriptionstring | null
    • resolutionstring | null
    • severitystring | null
    • productsnumber
  • performanceobject
    • clicksnumber
    • impressionsnumber
    • ctrnumber | null
    • conversionsnumber | null
    • conversionValuenumber | null
  • seriesarray of object
    • datestring
    • clicksnumber
    • impressionsnumber
    • freeClicksnumber | null
    • adsClicksnumber | null
  • topProductsarray of object
    • offerIdstring
    • merchantIdstring
    • titlestring | null
    • brandstring | null
    • statusone of: approved, limited, pending, disapproved
    • pricenumber | null
    • salePricenumber | null
    • currencystring | null
    • availabilitystring | null
    • linkstring | null
    • clicksnumber
    • impressionsnumber
    • ctrnumber | null
  • priceCompetitivenessobject | null
    • capturedOnstring | null
    • comparedProductsnumber
    • pricedAboveBenchmarknumber
    • pricedBelowOrAtBenchmarknumber
    • topPricedAbovearray of object
      • offerIdstring
      • titlestring | null
      • pricenumber
      • benchmarkPricenumber
      • currencystring | null
      • diffnumber
  • 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)
GET

/shopping/products

scope store:read

One 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

NameTypeRequired
clientstring (uuid)yes
fromstringno
tostringno
statusone of: approved, limited, pending, disapprovedno
issuestringno
searchstringno
cursorstringno
limitinteger · default 50 · min 1 · max 200no

Response 200

{ data, meta } — data is:

  • clientobject
    • idstring
    • namestring
  • connectedboolean
  • currencystring | null
  • totalnumber
  • productsarray of object
    • offerIdstring
    • merchantIdstring
    • titlestring | null
    • brandstring | null
    • statusone of: approved, limited, pending, disapproved
    • pricenumber | null
    • salePricenumber | null
    • currencystring | null
    • availabilitystring | null
    • linkstring | null
    • clicksnumber
    • impressionsnumber
    • ctrnumber | null
    • conditionstring | null
    • productTypestring | null
    • googleCategorystring | null
    • imageLinkstring | null
    • itemGroupIdstring | null
    • issuesarray of object
      • codestring
      • descriptionstring | null
      • severitystring | null
      • resolutionstring | null
      • destinationsarray of string
    • firstSeenAtstring
    • lastSeenAtstring
    • conversionsnumber | null
    • conversionValuenumber | null
  • nextCursorstring | 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)
GET

/overview

scope ads:read social:read web:read store:read

One 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

NameTypeRequired
clientstring (uuid)yes
fromstringyes
tostringyes
compareone of: previous, none · default previousno

Response 200

{ data, meta } — data is:

  • scopeobject
    • orgIdstring
    • clientobject
      • idstring
      • namestring
      • logoHrefstring | null
    • fromstring
    • tostring
    • previousFromstring | null
    • previousTostring | null
    • reportingTimezonestring
    • generatedAtstring
  • sourcesobject
    • metaobject
      • statusone of: ready, no_activity, not_connected, stale, partial, failed
      • syncedAtstring | null
      • coverageobjectoptional
        • fromstring | null
        • tostring | null
      • timezoneNotestring
      • messagestringoptional
      • freshnessobjectoptional
        • statusone of: fresh, partial, stale, never
        • oldestSuccessAtstring | null
        • newestSuccessAtstring | null
        • assetsarray of object
        • incompletearray of string
    • gadsobject
      • statusone of: ready, no_activity, not_connected, stale, partial, failed
      • syncedAtstring | null
      • coverageobjectoptional
        • fromstring | null
        • tostring | null
      • timezoneNotestring
      • messagestringoptional
      • freshnessobjectoptional
        • statusone of: fresh, partial, stale, never
        • oldestSuccessAtstring | null
        • newestSuccessAtstring | null
        • assetsarray of object
        • incompletearray of string
    • instagramobject
      • statusone of: ready, no_activity, not_connected, stale, partial, failed
      • syncedAtstring | null
      • coverageobjectoptional
        • fromstring | null
        • tostring | null
      • timezoneNotestring
      • messagestringoptional
      • freshnessobjectoptional
        • statusone of: fresh, partial, stale, never
        • oldestSuccessAtstring | null
        • newestSuccessAtstring | null
        • assetsarray of object
        • incompletearray of string
    • facebookobject
      • statusone of: ready, no_activity, not_connected, stale, partial, failed
      • syncedAtstring | null
      • coverageobjectoptional
        • fromstring | null
        • tostring | null
      • timezoneNotestring
      • messagestringoptional
      • freshnessobjectoptional
        • statusone of: fresh, partial, stale, never
        • oldestSuccessAtstring | null
        • newestSuccessAtstring | null
        • assetsarray of object
        • incompletearray of string
    • youtubeobject
      • statusone of: ready, no_activity, not_connected, stale, partial, failed
      • syncedAtstring | null
      • coverageobjectoptional
        • fromstring | null
        • tostring | null
      • timezoneNotestring
      • messagestringoptional
      • freshnessobjectoptional
        • statusone of: fresh, partial, stale, never
        • oldestSuccessAtstring | null
        • newestSuccessAtstring | null
        • assetsarray of object
        • incompletearray of string
    • ga4object
      • statusone of: ready, no_activity, not_connected, stale, partial, failed
      • syncedAtstring | null
      • coverageobjectoptional
        • fromstring | null
        • tostring | null
      • timezoneNotestring
      • messagestringoptional
      • freshnessobjectoptional
        • statusone of: fresh, partial, stale, never
        • oldestSuccessAtstring | null
        • newestSuccessAtstring | null
        • assetsarray of object
        • incompletearray of string
    • gscobject
      • statusone of: ready, no_activity, not_connected, stale, partial, failed
      • syncedAtstring | null
      • coverageobjectoptional
        • fromstring | null
        • tostring | null
      • timezoneNotestring
      • messagestringoptional
      • freshnessobjectoptional
        • statusone of: fresh, partial, stale, never
        • oldestSuccessAtstring | null
        • newestSuccessAtstring | null
        • assetsarray of object
        • incompletearray of string
    • shopifyobject
      • statusone of: ready, no_activity, not_connected, stale, partial, failed
      • syncedAtstring | null
      • coverageobjectoptional
        • fromstring | null
        • tostring | null
      • timezoneNotestring
      • messagestringoptional
      • freshnessobjectoptional
        • statusone of: fresh, partial, stale, never
        • oldestSuccessAtstring | null
        • newestSuccessAtstring | null
        • assetsarray of object
        • incompletearray of string
    • clarityobject
      • statusone of: ready, no_activity, not_connected, stale, partial, failed
      • syncedAtstring | null
      • coverageobjectoptional
        • fromstring | null
        • tostring | null
      • timezoneNotestring
      • messagestringoptional
      • freshnessobjectoptional
        • statusone of: fresh, partial, stale, never
        • oldestSuccessAtstring | null
        • newestSuccessAtstring | null
        • assetsarray of object
        • incompletearray of string
  • cardsarray of object
    • platformone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
    • labelstring
    • hrefstring
    • kpisarray of object
      • keystring
      • labelstring
      • valuenumber | null
      • previousnumber | null
      • deltanumber | null
      • directionone of: up-good, down-good, neutral
      • verdictone of: good, bad, flat
      • formatone of: money, int, pct, ratio, position
      • currencystring | nulloptional
      • sourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
      • definitionstring
      • volumeFloornumberoptional
    • notesarray of string
    • seriesarray of objectoptional
      • datestring
      • volumenumber | null
      • outcomenumber | null
    • seriesKeysobjectoptional
      • volumestring
      • outcomestring
    • highlightsobjectoptional
      • titlestring
      • subtitlestring
      • columnsarray of object
        • keystring
        • labelstring
      • rowsarray of object
        • idstring
        • namestring
        • detailstringoptional
        • hrefstringoptional
        • thumbnailHrefstring | nulloptional
        • cellsobject
      • footnotestringoptional
  • outcomesarray of object
    • keyone of: paid, audience, search, website, commerce
    • titlestring
    • questionstring
    • entriesarray of object
      • platformone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
      • primaryobject
        • keystring
        • labelstring
        • valuenumber | null
        • previousnumber | null
        • deltanumber | null
        • directionone of: up-good, down-good, neutral
        • verdictone of: good, bad, flat
        • formatone of: money, int, pct, ratio, position
        • currencystring | nulloptional
        • sourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
        • definitionstring
        • volumeFloornumberoptional
      • supportingarray of object
        • keystring
        • labelstring
        • valuenumber | null
        • previousnumber | null
        • deltanumber | null
        • directionone of: up-good, down-good, neutral
        • verdictone of: good, bad, flat
        • formatone of: money, int, pct, ratio, position
        • currencystring | nulloptional
        • sourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
        • definitionstring
        • volumeFloornumberoptional
      • hrefstring
    • missingarray of one of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
  • moversarray of object
    • platformone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
    • kpiobject
      • keystring
      • labelstring
      • valuenumber | null
      • previousnumber | null
      • deltanumber | null
      • directionone of: up-good, down-good, neutral
      • verdictone of: good, bad, flat
      • formatone of: money, int, pct, ratio, position
      • currencystring | nulloptional
      • sourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
      • definitionstring
      • volumeFloornumberoptional
    • sentimentone of: good, bad, neutral
    • hrefstring
  • signalsarray of object
    • entityIdstring
    • entityNamestring
    • levelone of: campaign, adset, ad
    • hrefstring
    • metricone of: hookRate, holdRate, lpvRate, ctr, cpc, costPerResult, frequency, results, spend
    • metricLabelstring
    • formatone of: pct, money, int, ratio
    • currencystring | null
    • previousnumber
    • currentnumber
    • changePctnumber
    • directionone of: up, down
    • sentimentone of: good, bad, neutral
    • scorenumber
  • attentionarray of object
    • idstring
    • sourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
    • severityone of: info, warning, critical
    • codeone of: low_balance, expired_connection, stale_data, partial_permissions, sync_failed, behaviour_spike
    • titlestring
    • detailstring
    • hrefstringoptional
  • competitorsobjectoptional
    • watchednumber
    • changesTodaynumber
    • topSeveritynumber | null
    • hrefstring
    • highlightsobject
      • titlestring
      • subtitlestring
      • columnsarray of object
        • keystring
        • labelstring
      • rowsarray of object
        • idstring
        • namestring
        • detailstringoptional
        • hrefstringoptional
        • thumbnailHrefstring | nulloptional
        • cellsobject
      • 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)
GET

/overview/roster

scope ads:read social:read web:read store:read

Every brand the key covers: connected platforms, each platform’s headline KPI with previous and delta, freshness, health and attention items

Query parameters

NameTypeRequired
fromstringyes
tostringyes

Response 200

{ data, meta } — data is:

  • fromstring
  • tostring
  • previousFromstring
  • previousTostring
  • rowsarray of object
    • clientIdstring
    • namestring
    • logoHrefstring | null
    • platformsarray of one of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
    • cellsobject
      • metaSpendobjectoptional
        • keystring
        • labelstring
        • valuenumber | null
        • previousnumber | null
        • deltanumber | null
        • directionone of: up-good, down-good, neutral
        • verdictone of: good, bad, flat
        • formatone of: money, int, pct, ratio, position
        • currencystring | nulloptional
        • sourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
        • definitionstring
        • volumeFloornumberoptional
      • metaResultsobjectoptional
        • keystring
        • labelstring
        • valuenumber | null
        • previousnumber | null
        • deltanumber | null
        • directionone of: up-good, down-good, neutral
        • verdictone of: good, bad, flat
        • formatone of: money, int, pct, ratio, position
        • currencystring | nulloptional
        • sourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
        • definitionstring
        • volumeFloornumberoptional
      • gadsSpendobjectoptional
        • keystring
        • labelstring
        • valuenumber | null
        • previousnumber | null
        • deltanumber | null
        • directionone of: up-good, down-good, neutral
        • verdictone of: good, bad, flat
        • formatone of: money, int, pct, ratio, position
        • currencystring | nulloptional
        • sourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
        • definitionstring
        • volumeFloornumberoptional
      • gadsConversionsobjectoptional
        • keystring
        • labelstring
        • valuenumber | null
        • previousnumber | null
        • deltanumber | null
        • directionone of: up-good, down-good, neutral
        • verdictone of: good, bad, flat
        • formatone of: money, int, pct, ratio, position
        • currencystring | nulloptional
        • sourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
        • definitionstring
        • volumeFloornumberoptional
      • igReachobjectoptional
        • keystring
        • labelstring
        • valuenumber | null
        • previousnumber | null
        • deltanumber | null
        • directionone of: up-good, down-good, neutral
        • verdictone of: good, bad, flat
        • formatone of: money, int, pct, ratio, position
        • currencystring | nulloptional
        • sourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
        • definitionstring
        • volumeFloornumberoptional
      • fbInteractionsobjectoptional
        • keystring
        • labelstring
        • valuenumber | null
        • previousnumber | null
        • deltanumber | null
        • directionone of: up-good, down-good, neutral
        • verdictone of: good, bad, flat
        • formatone of: money, int, pct, ratio, position
        • currencystring | nulloptional
        • sourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
        • definitionstring
        • volumeFloornumberoptional
      • ytViewsobjectoptional
        • keystring
        • labelstring
        • valuenumber | null
        • previousnumber | null
        • deltanumber | null
        • directionone of: up-good, down-good, neutral
        • verdictone of: good, bad, flat
        • formatone of: money, int, pct, ratio, position
        • currencystring | nulloptional
        • sourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
        • definitionstring
        • volumeFloornumberoptional
      • ga4Sessionsobjectoptional
        • keystring
        • labelstring
        • valuenumber | null
        • previousnumber | null
        • deltanumber | null
        • directionone of: up-good, down-good, neutral
        • verdictone of: good, bad, flat
        • formatone of: money, int, pct, ratio, position
        • currencystring | nulloptional
        • sourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
        • definitionstring
        • volumeFloornumberoptional
      • gscClicksobjectoptional
        • keystring
        • labelstring
        • valuenumber | null
        • previousnumber | null
        • deltanumber | null
        • directionone of: up-good, down-good, neutral
        • verdictone of: good, bad, flat
        • formatone of: money, int, pct, ratio, position
        • currencystring | nulloptional
        • sourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
        • definitionstring
        • volumeFloornumberoptional
      • shopifyNetSalesobjectoptional
        • keystring
        • labelstring
        • valuenumber | null
        • previousnumber | null
        • deltanumber | null
        • directionone of: up-good, down-good, neutral
        • verdictone of: good, bad, flat
        • formatone of: money, int, pct, ratio, position
        • currencystring | nulloptional
        • sourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
        • definitionstring
        • volumeFloornumberoptional
    • freshnessobject
      • metastring | nulloptional
      • gadsstring | nulloptional
      • instagramstring | nulloptional
      • facebookstring | nulloptional
      • youtubestring | nulloptional
      • ga4string | nulloptional
      • gscstring | nulloptional
      • shopifystring | nulloptional
      • claritystring | nulloptional
    • healthone of: ok, stale, attention
    • attentionarray of object
      • idstring
      • sourceone of: meta, gads, instagram, facebook, youtube, ga4, gsc, shopify, clarity
      • severityone of: info, warning, critical
      • codeone of: low_balance, expired_connection, stale_data, partial_permissions, sync_failed, behaviour_spike
      • titlestring
      • detailstring
      • hrefstringoptional

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)
GET

/ads/signals

scope ads:read

Meta ads signals: entity movements versus the previous period that are unusual against their siblings (robust z ≥ 3 and ≥ 10%), ranked by score

Query parameters

NameTypeRequired
clientstring (uuid)no
fromstringyes
tostringyes
levelone of: campaign, adset, ad · default adno
limitinteger · default 50 · min 1 · max 200no

Response 200

{ data, meta } — data is:

  • fromstring
  • tostring
  • previousFromstring
  • previousTostring
  • levelone of: campaign, adset, ad
  • comparedEntitiesnumber
  • signalsarray of object
    • entityIdstring
    • entityNamestring
    • levelone of: campaign, adset, ad
    • hrefstring
    • metricone of: hookRate, holdRate, lpvRate, ctr, cpc, costPerResult, frequency, results, spend
    • metricLabelstring
    • formatone of: pct, money, int, ratio
    • currencystring | null
    • previousnumber
    • currentnumber
    • changePctnumber
    • directionone of: up, down
    • sentimentone of: good, bad, neutral
    • scorenumber
  • truncatedboolean
  • 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)
GET

/ads/pacing

scope ads:read

Month-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

NameTypeRequired
clientstring (uuid)no

Response 200

{ data, meta } — data is:

  • pacingobject | null
    • monthStartstring
    • monthEndstring
    • todaystring
    • dayOfMonthnumber
    • daysInMonthnumber
    • daysRemainingnumber
    • fractionnumber
    • spendnumber
    • budgetnumber | null
    • budgetSourceone of: adset-daily, adset-lifetime, account-spend-cap | null
    • budgetUsedPctnumber | null
    • projectedSpendnumber | null
    • projectedVsBudgetPctnumber | null
    • dailyPaceSoFarnumber | null
    • idealDailyPacenumber | null
    • requiredDailyPacenumber | null
    • statusone of: under, on_track, over, unknown
    • currencystring | null
    • accountCountnumber
  • 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)
GET

/social/thumbnail

scope social:read

Stored thumbnail bytes for one post

Query parameters

NameTypeRequired
poststring (uuid)yes

Response 200

Image bytes

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)