Skip to main content
POST
local.analytics.search-keywords

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
startMonth
string

First month of the window, YYYY-MM, inclusive. Defaults to three months back.

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

Last month of the window, YYYY-MM, inclusive. Defaults to the current month.

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

Response

The result

results
object[]
required

Search terms that triggered impressions in the window, with their impression counts. Terms below a minimum impression threshold never appear.

startMonth
string

First month of the range actually reported, YYYY-MM.

endMonth
string

Last month of the range actually reported, YYYY-MM.