Getting Started

Sections

Theme switcher

Website Keywords

Header Parameters

api-keystring

Query Parameters

domainstring Required

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

traffic_sourcestring

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

Enum values:
allorganicpaid
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 desired metrics. Default to all available metrics.

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"]}]}

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