Website Keywords
Header Parameters
Query Parameters
Website domain without 'www.' (e.g., 'example.com')
Traffic source to fetch data for — 'all', 'organic', or 'paid'
allorganicpaidStart date in 'YYYY-MM' or 'YYYY-MM-DD' format
End date in 'YYYY-MM' or 'YYYY-MM-DD' format
Time granularity — 'monthly', 'weekly' or 'daily'
dailyweeklymonthlyWeb Source to fetch data for — 'total', 'desktop', or 'mobile_web'
desktopmobile_webtotalTwo-letter country code (e.g., 'us', 'gb', 'ww')
Comma-separated list of desired metrics. Default to all available metrics.
clickstraffic_sharecompetitionprimary_intentsecondary_intentpositionserp_featurestop_urlurl_countBranded keyword type - 'all', 'branded', or 'non_branded'
allbrandednon_brandedFilter 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"]}]}
Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'
jsonxmlNumber of items per page for pagination, default is 100
Page number for pagination, starting from 1
Sort order direction, 'true' for ascending, 'false' for descending. Default is 'false'
Sort order for the results, applied on the properties of the returned record;