Skip to main content
POST
local.analytics.performance

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
accountId
string

The connected business account, from local.locations.list. Optional when only one is connected.

Required string length: 1 - 256
metrics
enum<string>[]

Subset to return, e.g. ["websiteClicks", "callClicks"]. Omit for every metric.

Maximum array length: 11
Available options:
impressionsDesktopMaps,
impressionsDesktopSearch,
impressionsMobileMaps,
impressionsMobileSearch,
conversations,
directionRequests,
callClicks,
websiteClicks,
bookings,
foodOrders,
foodMenuClicks
fromDate
string

First day of the window, YYYY-MM-DD, inclusive. Defaults to 30 days back.

Pattern: ^\d{4}-\d{2}-\d{2}$
toDate
string

Last day of the window, YYYY-MM-DD, inclusive. Defaults to today.

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

The result

series
object[]
required

One entry per requested metric that has data.

fromDate
string

First day of the range actually reported, YYYY-MM-DD.

toDate
string

Last day of the range actually reported, YYYY-MM-DD.