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
On this page
- Website Audience
Website Content
Was this section helpful?
What made this section unhelpful for you?
On this page
- Website Content
Website Technologies
Constraints:
- Returns current technology data (no time series) for the last month
- granularity supports only monthly granularity
Input Parameters:
- domain: Website domain without 'www.' (e.g., 'example.com')
- main_domain_only: 'true' to include only the main domain, 'false' to include subdomains. 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'
- metrics: Comma separated list of metrics to retrieve. Available metrics: 'sub_category', 'pricing_model', 'description', 'first_seen_date'
- category: Main category of the technology
- status: Status of the technology: 'installed', 'removed' or 'installed_and_removed' (default)
- format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'
Output Data:
- technology: Name of the technology
- category: Main category of the technology
- sub_category: Sub-category of the technology
- pricing_model: Pricing model of the technology (Free, Paid, or Free/Paid)
- description: Description of the technology
- status: Status of the technology (Installed or Removed)
Was this section helpful?
What made this section unhelpful for you?
On this page
- Website Technologies
Website Folders
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'
- granularity: Time granularity — 'monthly', 'weekly' or 'daily'
- 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:
- folder: Folder path (top-level directory)
- share: The estimated traffic share percentage for this folder
- change: Percentage point change of folder traffic share compared to the previous month
Was this section helpful?
What made this section unhelpful for you?
On this page
- Website Folders
Popular pages
Constraints:
- granularity supports only monthly granularity, or daily granularity for the last 28 days only
- classify supported only in monthly granularity, daily granulairty supports 'All' value only
- web_source support only 'total'
- utm not supported when page is requested
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'
- classify: Set to one of the following values: 'evergreen' (page exists in all months), 'new', 'trending'. default is 'all'
- utm: Set to true to retieve only utm driven pages in the response
- granularity: Time granularity — 'monthly', 'weekly' or 'daily'
- metrics: Comma separated list of metrics to retrieve. Available metrics: 'share','change'
- main_domain_only: 'true' to include only the main domain, 'false' to include subdomains. Default is 'false'
- page: Specific page url
- format: Format in which the reply should be returned. Possible values: 'json' (default) or 'xml'
Output Data:
- page: Specific page url
- share: Percentage of total page traffic from the website traffic that comes from this country
- change: Percentage point change of page traffic share compared to the previous month
Was this section helpful?
What made this section unhelpful for you?
On this page
- Popular pages
Website Subdomains
Constraints:
- granularity supports only monthly granularity, or daily granularity for the last 28 days only
- web_source must be set to 'desktop' (default) or 'mobile_web' (total not supported)
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'
- 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:
- subdomain: The full subdomain of the website
- share: The estimated traffic share percentage for this subdomain
Was this section helpful?
What made this section unhelpful for you?
On this page
- Website Subdomains
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