v1Resources/Clients/getGet analytics across client locations

Get analytics across client locations

Aggregate the client’s location analytics for Google, Facebook or Bing over 7–90 days (default 30). Uses the UI’s trailing reporting-lag trim, totals and any-location connection status. Returns customer reporting metrics only. Requires analytics:read and access to the client.

get/api/v1/clients/{id}/analytics
analytics:read
Query parameters
idstringrequired
daysintegeroptional
sourcestring (google | facebook | bing)optional
Response
dataobjectrequired
locationIdstringoptional
sourcestring (google | facebook | bing)optional
periodobjectoptional
startstringoptional
endstringoptional
daysintegeroptional
requestedDaysintegeroptional
reportingLagDaysintegeroptional
labelsarray of stringoptional
seriesobjectoptional
totalsobjectoptional
impressionsnumberoptional
impressionsMapsnumberoptional
impressionsSearchnumberoptional
impressionsDesktopnumberoptional
impressionsMobilenumberoptional
profileViewsnumberoptional
directionRequestsnumberoptional
callClicksnumberoptional
websiteClicksnumberoptional
buttonClicksnumberoptional
allActionsnumberoptional
emptybooleanoptional
connectedbooleanoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The request conflicts with the current state of the resource — for example, changing the email or phone of a recipient who has already been messaged, or a team invite that was already accepted (or hasn't been accepted yet).
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The service is temporarily unavailable. Retry a credit grant with the same idempotency key.
get/api/v1/clients/{id}/analytics
Your API key
id *
days
source
{}

Guides that use this resource