Similarweb

Getting Started

Introduction

What's New in V5

Authentication

Making Your First Request

Guides

Available Data

Popular Use Cases

REST API vs Batch API

API Pricing & Data Credits

Error Handling & Troubleshooting

API Reference

<p class="slate-p " >Endpoints returning traffic and engagement statistics.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Web Intelligence API

Search Intelligence API

Sales Intelligence API

App Intelligence API

Gen AI Intelligence API

Similarweb MCP

MCP Integrations

Support and FAQ

Country Codes

Check Capabilities

Default

API V5 latest

Similarweb API V5 Documentation

Production

Sandbox

Ad Networks

AI Outreach

App Active Users

App Cross-Usage & Affinity

App Demographics

App Details

App Downloads

App IAB Categories

App Revenue

App Search

App Sessions

App Technographics (SDKs)

Contacts

Contacts Enrichment

Contacts Search

Lead Enrichment

Lead Enrichment - Company

Lead Enrichment - Website

Prompt Tracking

Keyword Competitors

Landing Pages

SERP Players - Aggregated

SERP Players - Clicks over time

Website Keywords

Website Audience

Audience Interest

Audience Overlap

Deduplicated Audience

Demographics

Demographics - specific groups

Website Content

Popular pages

Website Folders

Website Subdomains

Website Technologies

Website Performance

Marketing Channel Sources

PPC Spend

Referrals

Top Sites Ranking

Traffic & Engagement

Traffic Geography

Website Ranking

Website Segments

List predefined segments

List User Segments

Segments Analysis

Segments Marketing Channels

Check Data Credits Balance

Claude Integration

Cursor Integration

Manus Integration

Microsoft Copilot Integration

<p class="slate-p " >Returns predefined segments available for analysis.</p><p class="slate-p " ></p>

<p class="slate-p " >Returns traffic and engagement metrics over time for a custom segment.</p><p class="slate-p " ><strong class="slate-bold">Constraints:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">unique_visitors</code> metric can only be requested with <code class="slate-code">monthly</code> granularity.</div></li><li class="slate-li " ><div style="position:relative">Segment analysis does not support <code class="slate-code">mobile_web</code> as web source.</div></li></ul><p class="slate-p " ><strong class="slate-bold">Output Fields:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">visits</code>, <code class="slate-code">bounce_rate</code>, <code class="slate-code">page_views</code>, <code class="slate-code">visit_duration</code>,
<code class="slate-code">pages_per_visit</code>, <code class="slate-code">share</code>, and <code class="slate-code">unique_visitors</code>.</div></li></ul><p class="slate-p " ></p>

**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

<h4 class="slate-h4 " >Returns the IDs of the user&apos;s segments associated with your account, as defined on the Similarweb platform.</h4><p class="slate-p " ></p>

Returns the IDs of the user's segments associated with your account, as defined on the Similarweb platform.

api-key

traffic_and_engagement

segments

response

Access the List User Segments endpoint in the Similarweb API V5. Retrieve and manage custom audience segments created for website analysis and targeting.

Sections

List User Segments

Returns the IDs of the user's segments associated with your account, as defined on the Similarweb platform.

Header Parameters

Response

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Sections

List User Segments

Returns the IDs of the user's segments associated with your account, as defined on the Similarweb platform.

Header Parameters

ResponseExpand all

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Ask an AI

Code with AI

Response