Endpoints returning traffic and engagement statistics.

Constraints:

• snapshot endpoint - results are based on the last 3 months only. - granularity supports only monthly granularity for the last 3 months- web_source: 'desktop' or 'mobile_web' only ('total' is not supported)- traffic_source: 'organic' or 'paid' only ('all' is not supported)

Input Parameters:

• domain: Website domain without 'www.' (e.g., 'example.com')
• country: Two-letter country code (e.g., 'us', 'gb', 'ww')
• granularity: Time granularity — 'monthly', 'weekly' or 'daily'
• web_source: Web Source to fetch data for — 'total', 'desktop', or 'mobile_web'
• traffic_source: Traffic source to fetch data for — 'all', 'organic', or 'paid'
• main_domain_only: 'true' to analyze only the main domain (e.g., google.com), 'false' to include all subdomains (e.g., maps.google.com, docs.google.com). Default is 'false'
• metrics: Comma-separated list of metrics: score, shared_keywords
• format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'
• limit: Number of items per page for pagination, default is 100
• offset: Page number for pagination, starting from 1
• asc: Sort order direction, 'true' for ascending, 'false' for descending. Default is 'false'
• sort: Sort order for the results, applied on the properties of the returned record;

Output Data:

• url: Competitor domain URL
• score: Affinity score indicating similarity in keyword targeting
• shared_keywords: Number of shared keywords with the target domain

Constraints:

• granularity supports only monthly granularity for last 3 months only

Input Parameters:

• domain: Website domain without 'www.' (e.g., 'example.com')
• country: Two-letter country code (e.g., 'us', 'gb', 'ww')
• start_date: Start date in 'YYYY-MM' or 'YYYY-MM-DD' format
• end_date: End date in 'YYYY-MM' or 'YYYY-MM-DD' format
• granularity: Time granularity — 'monthly', 'weekly' or 'daily'
• traffic_source: Traffic source to fetch data for — 'all', 'organic', or 'paid'
• branded_type: Branded keyword type - 'all', 'branded', or 'non_branded'
• web_source: Web Source to fetch data for — 'total', 'desktop', or 'mobile_web'
• metrics: Comma-separated list of metrics: clicks, traffic_share, competition, primary_intent, secondary_intent, position, serp_features, top_url, url_count
• keywords_filter_rules: 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"]}]}
• range_filters: Range filters as URL-encoded JSON array. Each filter specifies a field name and min/max values. Structure: {[{"field": "cpc | volume | zero_clicks | difficulty", "min": number, "max": number}]}. Example: {[{"field": "cpc", "min": 0.5, "max": 2.0}, {"field": "volume", "min": 1000}]}.
• format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'
• limit: Number of items per page for pagination, default is 100
• offset: Page number for pagination, starting from 1
• asc: Sort order direction, 'true' for ascending, 'false' for descending. Default is 'false'
• sort: Sort order for the results, applied on the properties of the returned record;

Output Data:

• keyword: A single keyword or name of a keyword group to analyze
• clicks: The number of keyword search clicks to the website
• traffic_share: The share of the traffic to the website
• competition: Competition level for ad placement on the keyword.
• primary_intent: An estimation of what peaople searching for this keywords are trying to acheive.
• secondary_intent: Secondary intent for keyword search.
• position: The keyword's latest universal position within the selected time range. Not avaialble for 'world' country.
• serp_features: SERP features the domains rank for on the analyzed keyword
• top_url: The site url with the highest organic position that ranks for the analyzed keyword

Constraints:

• granularity supports only monthly granularity for the last 12 months, or daily granularity for the last 28 days only- is_keyword_regex cannot be used together with is_keyword_group, only one of them can be used.

Input Parameters:

• keyword: A single keyword or name of a keyword group to analyze
• is_keyword_group: A boolean flag to specify if a keyword group is provided or a single keyword. Default is 'false'
• start_date: Start date in 'YYYY-MM' or 'YYYY-MM-DD' format
• end_date: End date in 'YYYY-MM' or 'YYYY-MM-DD' format
• granularity: Time granularity — 'monthly', 'weekly' or 'daily'
• web_source: Web Source to fetch data for — 'total', 'desktop', or 'mobile_web'
• country: Two-letter country code (e.g., 'us', 'gb', 'ww')
• traffic_source: Traffic source to fetch data for — 'all', 'organic', or 'paid'
• format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'

Output Data:

• domain: Website domain without 'www.' (e.g., 'example.com')
• clicks: The number of keyword search clicks to the website

Constraints:

• granularity supports only monthly granularity for the last 3 months, or daily granularity for the last 28 days only- is_keyword_regex cannot be used together with is_keyword_group, only one of them can be used.

Input Parameters:

• keyword: A single keyword or name of a keyword group to analyze
• is_keyword_group: A boolean flag to specify if a keyword group is provided or a single keyword. Default is 'false'
• start_date: Start date in 'YYYY-MM' or 'YYYY-MM-DD' format
• end_date: End date in 'YYYY-MM' or 'YYYY-MM-DD' format
• granularity: Time granularity — 'monthly', 'weekly' or 'daily'
• web_source: Web Source to fetch data for — 'total', 'desktop', or 'mobile_web'
• country: Two-letter country code (e.g., 'us', 'gb', 'ww')
• traffic_source: Traffic source to fetch data for — 'all', 'organic', or 'paid'
• format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'
• limit: Number of items per page for pagination, default is 100
• offset: Page number for pagination, starting from 1
• asc: Sort order direction, 'true' for ascending, 'false' for descending. Default is 'false'
• sort: Sort order for the results, applied on the properties of the returned record;

Output Data:

• site: Website sub-domain without 'www.' (e.g., 'developer.example.com')
• domain: Website domain without 'www.' (e.g., 'example.com')
• clicks: Sum of clicks the domain receives for the analyzed keyword
• traffic_share: The share of the traffic to the website
• top_url: The site url with the highest organic position that ranks for the analyzed keyword
• top_url_position: Top latest blended position of the top_url in the selected timeframe
• serp_features: SERP features the domains rank for on the analyzed keyword