Getting Started

Sections

Theme switcher

SERP Players - Aggregated

Header Parameters

api-keystring

Query Parameters

keywordstring Required

A single keyword or name of a keyword group to analyze

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_shareserp_featurestop_urltop_url_position
is_keyword_groupboolean

A boolean flag to specify if a keyword group is provided or a single keyword. Default is 'false'

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 helpful for you?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section helpful for you?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in Claude

Code with AI