Endpoints returning traffic and engagement statistics.

Constraints:

• unique_visitors metric can only be requested for monthly granularity
• new_users and returning_users metrics can only be requested for monthly granularity and total web_source

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
• mtd: 'true' sets end_date to the latest available day's data (month-to-date). Default is 'false'
• web_source: Web Source to fetch data for — 'total', 'desktop', or 'mobile_web'
• granularity: Time granularity — 'monthly', 'weekly' or 'daily'
• metrics: Comma-separated list of metrics: visits, average_visit_duration, pages_per_visit, bounce_rate, page_views, unique_visitors, new_users, returning_users
• main_domain_only: 'true' to include only the main domain, 'false' to include subdomains. Default is 'false'
• format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'

Output Data:

• visits: Estimated number of visits to the website
• bounce_rate: Percentage of visits that view only one page on the website
• average_visit_duration: Average time on website (in seconds)
• pages_per_visit: Average number of pages viewed per visit
• page_views: Estimated number of pages viewed on the website
• unique_visitors: Estimated number of unique visitors (not deduplicated across devices) to the website
• new_users: Estimated number of new users to the website
• returning_users: Estimated number of returning users to the website

Constraints:

• web_source support only 'total'
• granularity supports only monthly granularity, or daily granularity for the last 28 days 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
• web_source: Web Source to fetch data for — 'total', 'desktop', or 'mobile_web'
• metrics: Comma-separated list of metrics: country_rank, category, category_rank
• granularity: Time granularity — 'monthly', 'weekly' or 'daily'
• format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'

Output Data:

• country_rank: Rank of the website in the specified country (1 is best)
• category: Website industry category identifier
• category_rank: Rank of the website within its industry category (1 is best)

Constraints:

• Returns current top sites data (no time series) for up to the last 3 months
• granularity supports only monthly granularity
• Data is limited to 1 last month for specific channel and up to 3 months for the 'total' channel

Input Parameters:

• 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
• web_source: Web Source to fetch data for — 'total', 'desktop', or 'mobile_web'
• granularity: Time granularity — 'monthly', 'weekly' or 'daily'
• category: Website industry category identifier
• channel: Type of traffic source: 'total' (default), 'search', 'organic_search', 'paid_search', 'social', 'display_ads', 'referral', 'direct' and 'mail'.
• format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'

Output Data:

• domain: The domain of a to ranked website in a given category
• category_rank: Rank of the website within its industry category (1 is best)

Constraints:

• average_visit_duration, pages_per_visit, bounce_rate metrics can only be requested for desktop web source
• Non-desktop web sources (total, mobile_web) support only monthly granularity and do not support mtd parameter

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
• mtd: 'true' sets end_date to the latest available day's data (month-to-date). Default is 'false'
• web_source: Web Source to fetch data for — 'total', 'desktop', or 'mobile_web'
• granularity: Time granularity — 'monthly', 'weekly' or 'daily'
• metrics: Comma-separated list of metrics: visits, average_visit_duration, pages_per_visit, bounce_rate
• main_domain_only: 'true' to include only the main domain, 'false' to include subdomains. Default is 'false'
• format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'

Output Data:

• visits: Estimated number of visits to the website
• bounce_rate: Percentage of visits that view only one page on the website
• average_visit_duration: Average time on website (in seconds)
• pages_per_visit: Average number of pages viewed per visit

Constraints:

• granularity supports only monthly granularity, or daily granularity for the last 28 days only
• 'desktop' web_source supports both daily (last 28 days) and monthly granularity, while mobile_web and total (default) support only monthly granularity
• change data is not available for daily granularity
• publishers, advertisers and social referral types are only supported for desktop web source

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
• web_source: Web Source to fetch data for — 'total', 'desktop', or 'mobile_web'
• granularity: Time granularity — 'monthly', 'weekly' or 'daily'
• referral_type: Type of referral: 'incoming' (default) for traffic sources, 'outgoing' for traffic destinations, 'publishers' for incoming advertiser websites, 'advertisers' for outgoing advertiser websites, 'social' for incoming social networks websites
• format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'

Output Data:

• domain: The website that either sends traffic to or receives traffic from the analyzed site.
• share: Percentage of total referral traffic to or from the analyzed website that comes from this domain
• change: Percentage point change of referral traffic share compared to the previous month
• visits: Estimated number of visits to the website

Constraints:

• granularity support only monthly granularity
• web_source must be set to 'total' or 'desktop'

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
• web_source: Web Source to fetch data for — 'total', 'desktop', or 'mobile_web'
• granularity: Time granularity — 'monthly', 'weekly' or 'daily'
• currency: Currency for PPC spend: 'USD', 'EUR', 'AUD', 'GBP' or 'JPY'. Default is 'USD'
• main_domain_only: 'true' to include only the main domain, 'false' to include subdomains. Default is 'false'
• format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'

Output Data:

• ppc_spend: Estimated monthly spend on paid search advertising for the specified currency

Constraints:

• granularity support only monthly granularity, or daily granularity for the last 28 days only

Input Parameters:

• domain: Website domain without 'www.' (e.g., 'example.com')
• start_date: Start date in 'YYYY-MM' or 'YYYY-MM-DD' format
• end_date: End date in 'YYYY-MM' or 'YYYY-MM-DD' format
• web_source: Web Source to fetch data for — 'total', 'desktop', or 'mobile_web'
• granularity: Time granularity — 'monthly', 'weekly' or 'daily'
• metrics: Comma-separated list of metrics: country, country_name, rank, share, visits, average_visit_duration, pages_per_visit, bounce_rate
• main_domain_only: 'true' to include only the main domain, 'false' to include subdomains. Default is 'false'
• format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'

Output Data:

• country: Two-letter country code (e.g., 'us', 'gb', 'ww')
• country_numeric: Numeric code of the country (e.g., '840', '376)
• country_name: Full name of the country
• rank: Global rank of the website in the specified country
• share: Percentage of total site traffic that comes from this country
• visits: Estimated number of visits to the website
• average_visit_duration: Average time on website (in seconds)
• pages_per_visit: Average number of pages viewed per visit
• bounce_rate: Percentage of visits that view only one page on the website

Constraints:

• granularity supports only monthly granularity for the last 3 months

Input Parameters:

• domain: Website domain without 'www.' (e.g., 'example.com')
• category: Website industry category identifier
• metrics: Comma-separated list of metrics: rank, affinity, has_adsense
• format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'

Output Fields:

• domain: The domain of a website similar to the requested domain
• category: Website industry category identifier
• rank: Similarity rank of the domain (higher means more similar)
• affinity: Similarity score between the analyzed website and the related domain
• has_adsense: Indicates whether the related domain runs Google AdSense

Constraints:

• web_source supports only 'desktop'
• granularity supports only monthly granularity, or daily granularity for the last 28 days only
• change data is not available for daily granularity and for outgoing ad networks type

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
• web_source: Web Source to fetch data for — 'total', 'desktop', or 'mobile_web'
• granularity: Time granularity — 'monthly', 'weekly' or 'daily'
• ad_network_type: Type of ad network: 'incoming' (default) for traffic sources, 'outgoing' for traffic destinations
• format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'

Output Data:

• ad_network: Name of the ad network
• share: Percentage of ad traffic share for this ad network
• change: Percentage point change of ad network traffic share compared to the previous month