MetricsGoMetricsGo
Start free

API reference

Read access to the Meta ads, organic social, website (Google Analytics and Search Console) and Shopify store data MetricsGo has synced for your organisation. All numbers are stored data — the API never calls Meta on your behalf; check meta.syncedAt for freshness. 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.

https://metricsgo.srv1821420.hstgr.cloud/api/v1Download OpenAPI 3.1 document (JSON, for tools) →Metric definitions →
  • GET/meThe calling key: org, scopes, client restriction
  • GET/clientsClients this key can read, with their ad accounts and Pages
  • GET/ads/overviewAds overview: KPIs, previous period, daily series, funds, widgets
  • GET/ads/entitiesCampaigns, ad sets or ads with range totals (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, previous 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/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/social/thumbnailStored thumbnail bytes for one post
GET

/me

any scope

The calling key: org, scopes, client 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

Clients this key can read, with their ad accounts and Pages

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

/ads/overview

scope ads:read

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

Query parameters

NameTypeRequired
clientstring (uuid)no
fromstringyes
tostringyes
campaignIdstringno
adSetIdstringno
adIdstringno

Response 200

{ data, meta } — data is:

  • kpisobject
    • spendnumber
    • impressionsnumber
    • reachnumber
    • clicksnumber
    • ctrnumber
    • cpcnumber
    • videoViewsnumber
    • purchaseValuenumber
    • resultsnumber
    • resultTypestring | null
    • costPerResultnumber | null
  • previousobject
    • spendnumber
    • resultsnumber
    • impressionsnumber
    • clicksnumber
    • reachnumber
  • fundsobject
    • balancenumber | null
    • spentnumber | null
    • capnumber | null
  • lowBalancearray of object
    • accountNamestring
    • balancenumber
    • thresholdnumber
    • currencystring | null
  • seriesarray of object
    • datestring
    • spendnumber
    • impressionsnumber
    • clicksnumber
    • reachnumber
    • resultsnumber
  • campaignsarray of object
    • idstring
    • namestring
    • statusstring | null
    • effectiveStatusstring | 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
      • reachnumber
    • platformsarray of object
      • platformstring
      • impressionsnumber
      • spendnumber
      • clicksnumber
    • placementsarray of object
      • platformstring
      • positionstring
      • impressionsnumber
      • spendnumber
      • 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 (capped at 500; see meta.truncated)

Query parameters

NameTypeRequired
levelone of: campaign, adset, adyes
clientstring (uuid)no
fromstringyes
tostringyes
searchstringno

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, previous period and daily series

Query parameters

NameTypeRequired
clientstring (uuid)no
fromstringyes
tostringyes

Response 200

{ data, meta } — data is:

  • fromstring
  • tostring
  • previousFromstring
  • previousTostring
  • 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
      • 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
      • 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
    • 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
    • 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

/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
    • 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
      • 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
      • 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
      • 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
      • 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
      • 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

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