Getting Started

Sections

Theme switcher

Website Keywords

Header Parameters

api-keystring

Query Parameters

domainstring Required

Enter website of interest, without 'www.' or brackets {}

granularitystring

Time granularity for the returned values

Enum values:
monthly
countrystring

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

start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

traffic_sourcestring

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

Enum values:
allorganicpaid
web_sourcestring

The device/platform the traffic is coming from

Enum values:
desktopmobile_webtotal
metricsarray

Comma-separated list of metrics: clicks, traffic_share, competition, primary_intent, secondary_intent, position, serp_features, top_url, url_count

Style
form
Enum values:
clickstraffic_sharecompetitionprimary_intentsecondary_intentpositionserp_featurestop_urlurl_count
branded_typestring

Branded keyword type - 'all', 'branded', or 'non_branded'

Enum values:
allbrandednon_branded
keywords_filter_rulesarray

Filter rules for keywords as a URL-encoded JSON array. Each rule specifies whether to include/exclude keywords and how to match them (exact or phrase). Structure: {[{"type": "include | exclude", "match_type": "exact | phrase", "keywords": ["keyword1", "keyword2"]}]}. Example: {[{"type": "exclude", "match_type": "phrase", "keywords": ["brand name", "company"]}, {"type": "include", "match_type": "exact", "keywords": ["marketing"]}]}

Style
form
formatstring

Format in which the reply should be returned

Enum values:
jsonxml
limitinteger

Sets how many results to return.

offsetinteger

Defines the number of results to skip

ascboolean | null

Orders the results by ascending or descending

sortstring

Selects a specific metric to order results by

Response

200
Object

OK

Response Attributes

metaobject

Show child attributes

dataarray | null

Show child attributes

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot