Skip to main content
POST
google.domain.category-metrics

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
categoryCodes
string[]
required

Category codes from the Labs categories dictionary (1-5).

Required array length: 1 - 20 elements
Required string length: 1 - 256
firstDate
string
required

First date of comparison period.

Required string length: 1 - 512
secondDate
string
required

Second date of comparison period.

Required string length: 1 - 512
correlate
boolean

Correlate data with previously obtained datasets (default true).

etvMax
integer

Maximum current organic ETV of the domain.

Required range: 0 <= x <= 1000000
etvMin
integer

Minimum current organic ETV of the domain.

Required range: 0 <= x <= 1000000
includeSubdomains
boolean

Return subdomains in the API response (default true).

language
string

Two-letter language code, e.g. "en". Default "en".

Pattern: ^[a-z]{2}$
limit
number

How many to return, 1 to 20. Default 10.

Required range: x >= 1
location
string

Location in English, e.g. United States or London,England,United Kingdom. Default United States.

Required string length: 1 - 128
topCategoriesCount
integer

Number of additional domain categories (max 5).

Required range: 0 <= x <= 1000000

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.