Getting Started

Sections

Theme switcher

Introduction

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Introduction

What's New in V5

Was this section helpful?

What made this section unhelpful for you?

On this page
  • What's New in V5

Authentication

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Authentication

Making Your First Request

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Making Your First Request

Available Data

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Available Data

Popular Use Cases

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Popular Use Cases

REST API vs Batch API

Was this section helpful?

What made this section unhelpful for you?

On this page
  • REST API vs Batch API

API Pricing & Data Credits

On this page
  • API Pricing & Data Credits

Error Handling & Troubleshooting

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Error Handling & Troubleshooting

Web Intelligence API

Endpoints returning traffic and engagement statistics.

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Web Intelligence API

Website Performance

On this page
  • Website Performance

Website Segments

On this page
  • Website Segments

Website Audience

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Website Audience

Demographics

Constraints:

  • granularity supports only monthly granularity

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
  • metrics: Comma-separated list of metrics: age_18_to_24_share, age_25_to_34_share, age_35_to_44_share, age_45_to_54_share, age_55_to_64_share, age_65_plus_share, male_share, female_share
  • granularity: Time granularity — 'monthly', 'weekly' or 'daily'
  • format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'

Output Data:

  • age_18_to_24_share: The share of the visitors to the website who are between the ages 18 to 24
  • age_25_to_34_share: The share of the visitors to the website between who are the ages 25 to 34
  • age_35_to_44_share: The share of the visitors to the website between who are the ages 35 to 44
  • age_45_to_54_share: The share of the visitors to the website between who are the ages 45 to 54
  • age_55_to_64_share: The share of the visitors to the website between who are the ages 55 to 64
  • age_65_plus_share: The share of the audience to the websites of ages 64 and above
  • male_share: The share of the male visitors to the website
  • female_share: The share of the female visitors to the website
Was this section helpful?

What made this section unhelpful for you?

On this page
  • Demographics

Demographics - specific groups

Constraints:

  • granularity supports only monthly granularity
  • Must specify at least one age_bucket
  • At least on of male_data or female_data must be 'true'

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
  • metrics: Comma-separated list of metrics: share, pages_per_visit, bounce_rate, visit_duration
  • granularity: Time granularity — 'monthly', 'weekly' or 'daily'
  • gender: Gender filter: 'male', 'female', or 'all'. Default is 'all'
  • age_buckets: Comma-separated list of ages representing age groups: 18, 25, 35, 45, 55, 65
  • format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'

Output Data:

  • share: The share of the requested group out of the total traffic to the website
  • pages_per_visit: Average number of pages viewed per visit
  • bounce_rate: Percentage of visits that view only one page on the website
  • average_visit_duration: Average time on website (in seconds)
Was this section helpful?

What made this section unhelpful for you?

On this page
  • Demographics - specific groups

Deduplicated Audience

Constraints:

  • granularity supports only monthly granularity

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
  • metrics: Comma-separated list of metrics: total_deduplicated_audience, desktop_only_audience_share, desktop_only_audience_visitors, mobile_web_only_audience_share, mobile_web_only_audience_visitors, desktop_and_mobile_web_audience_share, desktop_and_mobile_web_audience_visitors
  • 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:

  • total_deduplicated_audience: The average number of individuals who visited a website across desktop and mobile web (deduplicated across devices)
  • desktop_only_audience_share: The share of users out of the total deduplicated audience that visit a website on desktop only
  • desktop_only_audience_visitors: The number of users that visit a website on desktop only
  • mobile_web_only_audience_share: The share of users out of the total deduplicated audience that visit a website on mobile web only
  • mobile_web_only_audience_visitors: The number of users that visit a website on mobile web only
  • desktop_and_mobile_web_audience_share: The share of users out of the total deduplicated audience that visit a website on both desktop and mobile web
  • desktop_and_mobile_web_audience_visitors: The number of users that visit a website on both desktop and mobile web
Was this section helpful?

What made this section unhelpful for you?

On this page
  • Deduplicated Audience

Audience Interest

Constraints:

  • granularity supports only monthly granularity

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: affinity, overlap, pop_change, has_adsense, domain
  • 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:

  • domain: Related website frequently visited by the same audience as the analyzed site
  • affinity: Similarity score between the analyzed website and the related domain
  • overlap: Percentage of visitors shared between the analyzed website and the related domain
  • pop_change: Monthly change in overlap percentage points
  • has_adsense: Indicates whether the related domain runs Google AdSense
Was this section helpful?

What made this section unhelpful for you?

On this page
  • Audience Interest

Audience Overlap

Constraints:

  • domains must include between 2 and 5 unique domains
  • granularity supports only monthly granularity

Input Parameters:

  • domains: Comma-separated list of unique website domains (without 'www.')
  • 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'
  • format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'

Output Data:

  • domains: Comma-separated list of unique website domains (without 'www.')
  • overlap_unique_visitors: Estimated number of unique visitors (not deduplicated across devices) that entered all websites
  • union_unique_visitors: Estimated number of unique visitors (not deduplicated across devices) that entered at least on of the websites
Was this section helpful?

What made this section unhelpful for you?

On this page
  • Audience Overlap

Website Content

On this page
  • Website Content

Search Intelligence API

On this page
  • Search Intelligence API

Sales Intelligence API

On this page
  • Sales Intelligence API

App Intelligence API

On this page
  • App Intelligence API

Gen AI Intelligence API

On this page
  • Gen AI Intelligence API

Setup and Configuration

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Setup and Configuration

MCP Integrations

On this page
  • MCP Integrations

Overview

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Overview

Data Visualization

On this page
  • Data Visualization

Productivity & Analytics

On this page
  • Productivity & Analytics

CRM & Marketing

On this page
  • CRM & Marketing

Cloud & Data Platforms

On this page
  • Cloud & Data Platforms

FAQ

Was this section helpful?

What made this section unhelpful for you?

On this page
  • FAQ

Country Codes

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Country Codes

Check Capabilities

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Check Capabilities
View as Markdown

Ask an AI

Open in ChatGPTOpen in Claude

Code with AI