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

Was this section helpful?

What made this section unhelpful for you?

On this page
  • Website Segments

List User Segments

Was this section helpful?

What made this section unhelpful for you?

On this page
  • List User Segments

List predefined segments

Returns predefined segments available for analysis.

Was this section helpful?

What made this section unhelpful for you?

On this page
  • List predefined segments

Segments Analysis

Returns traffic and engagement metrics over time for a custom segment.

Constraints:

  • unique_visitors metric can only be requested with monthly granularity.
  • Segment analysis does not support mobile_web as web source.

Output Fields:

  • visits, bounce_rate, page_views, visit_duration, pages_per_visit, share, and unique_visitors.
Was this section helpful?

What made this section unhelpful for you?

On this page
  • Segments Analysis

Segments Marketing Channels

Constraints:

  • bounce_rate, page_views, visit_duration, pages_per_visit metrics can only be requested for desktop web source
  • 'desktop' web_source supports 'weekly' and 'monthly' granularity; 'total' web_source supports 'monthly' granularity only.
  • Segment analysis does not support mobile_web web source

Input Parameters:

  • segment: Segment ID to analyze
  • 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'
  • metrics: Comma-separated list of metrics: visits, bounce_rate, page_views, average_visit_duration, pages_per_visit
  • 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
Was this section helpful?

What made this section unhelpful for you?

On this page
  • Segments Marketing Channels

Website Audience

On this page
  • Website Audience

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