Getting Started

Sections

Theme switcher

Keyword Competitors

Header Parameters

api-keystring

Query Parameters

domainstring Required

Website domain without 'www.' (e.g., 'example.com')

start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format

granularitystring

Time granularity — 'monthly', 'weekly' or 'daily'

Enum values:
dailyweeklymonthly
web_sourcestring

Web Source to fetch data for — 'total', 'desktop', or 'mobile_web'

Enum values:
desktopmobile_webtotal
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

metricsarray

Comma-separated list of metrics: score, shared_keywords

Enum values:
scoreshared_keywords
main_domain_onlyboolean

'true' to analyze only the main domain (e.g., google.com), 'false' to include all subdomains (e.g., maps.google.com, docs.google.com). Default is 'false'

traffic_sourcestring

Traffic source to fetch data for — 'all', 'organic', or 'paid'

Enum values:
allorganicpaid
formatstring

Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'

Enum values:
jsonxml
limitinteger

Number of items per page for pagination, default is 100

offsetinteger

Page number for pagination, starting from 1

ascboolean

Sort order direction, 'true' for ascending, 'false' for descending. Default is 'false'

Nullable:
True
sortstring

Sort order for the results, applied on the properties of the returned record;

Response

200
Object
Success

Response Attributes

metaobject

Show child attributes

dataarray
Nullable:
True

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in Claude

Code with AI