Getting Started

Sections

Theme switcher

Keywords Overview

Header Parameters

api-keystring

Query Parameters

keywordstring Required

A single keyword or name of a keyword group to analyze

granularitystring

Time granularity for the returned values

Enum values:
dailymonthly
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

web_sourcestring

The device/platform the traffic is coming from

Enum values:
desktopmobile_webtotal
metricsarray

Comma-separated list of metrics: clicks, paid_clicks, classic_organic_clicks, organic_serp_features_clicks, search_ads_clicks, pla_clicks, total_valid_serp_clicks, total_volume, zero_clicks_searches, difficulty, competition, ai_overview, cpc_low_bid, cpc_high_bid, transactional_intent_volume, informational_intent_volume, navigational_intent_volume, local_intent_volume, job_search_intent_volume

Enum values:
clickspaid_clicksclassic_organic_clicksorganic_serp_features_clickssearch_ads_clickspla_clickstotal_valid_serp_clicksvolumezero_clicksdifficulty
... 9 other enums
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

Enum values:
jsonxml
limitinteger

Sets how many results to return.

offsetinteger

Defines the number of results to skip

ascboolean

Orders the results by ascending or descending

Nullable:
True
sortstring

Selects a specific metric to order results by

Response

200
Object
OK

Response Attributes

metaobject

Show child attributes

dataarray
Nullable:
True

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