← Back to all apps

Similarweb

Businessby Similarweb Inc
Launched May 28, 2026 on ChatGPT

Research any website or app using Similarweb's market intelligence data. Analyze competitor traffic, uncover top keywords, explore audience demographics, and benchmark performance across industries—all through simple prompts. Ask things like "Show me Nike's traffic sources breakdown" or "What keywords is Adidas ranking for?" and get real-time insights without switching tools. Whether you're a marketer, analyst, investor, or strategist, Similarweb helps you turn competitive questions into answers instantly.

137ChatGPT Tools
22Claude Tools
Similarweb IncDeveloper
BusinessCategory

Use Cases

productivity

Available Tools

Get-ai-traffic-landing-pages-agg

get-ai-traffic-landing-pages-agg
Full Description

[ai_research] Get AI chatbot referral traffic per landing page Returns estimated website visits from AI chatbot referrals at the landing-page (URL) level, based on Similarweb's proprietary real-user panel data. Each row represents one URL × one LLM source combination, aggregated over the queried date range.

Parameters (2 required, 5 optional)
Required
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Options:dailyweeklymonthly
Default: null
limitinteger

Maximum number of rows to return per page. 1-1000.

Default: null

Get-ai-traffic-overview

get-ai-traffic-overview
Full Description

[ai_research] AI Traffic Overview Returns AI chatbot referral traffic per LLM source for a domain with optional visits and share metrics.

Parameters (1 required, 4 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Default: null

Get-ai-traffic-overview-aggregated

get-ai-traffic-overview-aggregated
Full Description

[ai_research] AI Traffic Overview Aggregated Returns AI chatbot referral traffic per LLM source for a domain with optional visits and share metrics.

Parameters (1 required, 4 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Default: null

Get-apps-active-users

get-apps-active-users
Full Description

[apps] App Active Users Returns the estimated active users for mobile apps across Google Play Store, Apple App Store, and both stores (“Unified”) over the given time frame.

Parameters (3 required, 4 optional)
Required
app_idstring

Unique application identifier. Google app IDs consist of letters, numbers, and dots (e.g., 'com.facebook.katana'), while Apple app IDs are numeric only (e.g., '447188370'). **Constraints:** is required and cannot be empty

countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww') **Constraints:** is required and cannot be empty, must be a valid two-letter country code

storestring

Application store identifier **Constraints:** either 'google', 'apple' or 'unified'

Options:googleappleunified
Optional
data_versionstring

Data version. Discriminated type defined with `data_version` query parameter. Bound via M:API.Common.Binders.ModelBindingContextExtensions.BindAndResolveDataVersion(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext,API.Requests.V5.BaseRequests.IDataVersionRequest). Subtypes:<list type="bullet"><item>API.Requests.V5.BaseRequests.ResolvedDataVersionBranch: in case `data_version` parameter is defined and correct (validated).</item><item>API.Requests.V5.BaseRequests.UnspecifiedDataVersionBranch: in case `data_version` parameter is missing or set to empty string. Uses `master` branch hash, no branch name specified.</item><item>API.Requests.V5.BaseRequests.InvalidDataVersionBranch: in case `data_version` parameter is defined but not correct (validation can't find name in validation list).</item></list> If user needs only API.Requests.V5.BaseRequests.IHasHash.Hash, they may use API.Requests.V5.BaseRequests.IHasHash type to check for that.

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Options:dailyweeklymonthly
Default: null

Get-apps-audience-demographics

get-apps-audience-demographics
Full Description

[apps] App Audience Demographics Returns the percentage share of each audience for the given app.

Parameters (2 required, 5 optional)
Required
app_idstring

Unique application identifier. Google app IDs consist of letters, numbers, and dots (e.g., 'com.facebook.katana'), while Apple app IDs are numeric only (e.g., '447188370'). **Constraints:** is required and cannot be empty

storestring

Application store identifier **Constraints:** either 'google' or 'apple'

Options:googleapple
Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
data_versionstring

Optional data version name for accessing alternative data versions

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** must be 'monthly'. No other granularity is supported.

Default: null

Get-apps-audience-interests

get-apps-audience-interests
Full Description

[apps] App Audience Interests Retrieves a ranked list of apps that share the highest audience overlap with the input app, measured by the percentage of cross-usage and their relative affinity.

Parameters (2 required, 6 optional)
Required
app_idstring

Unique application identifier. Google app IDs consist of letters, numbers, and dots (e.g., 'com.facebook.katana'), while Apple app IDs are numeric only (e.g., '447188370'). **Constraints:** is required and cannot be empty

storestring

Application store identifier **Constraints:** either 'google' or 'apple'

Options:googleapple
Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** must be 'monthly'. No other granularity is supported.

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-apps-changelog

get-apps-changelog
Full Description

[apps] App Changelog Returns a paginated history of detected changes to an app's store listing metadata across Google Play Store and Apple App Store, including title, description, screenshots, SDKs, and more.

General Constraints:

{
  "event_type": "optional \u2014 comma-separated event types: added, removed, changed"
}
Parameters (2 required, 7 optional)
Required
app_idstring

Unique application identifier. Google app IDs consist of letters, numbers, and dots (e.g., 'com.facebook.katana'), while Apple app IDs are numeric only (e.g., '447188370'). **Constraints:** is required and cannot be empty

storestring

Application store identifier **Constraints:** either 'google' or 'apple'

Options:googleapple
Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww') **Constraints:** optional (default ww) — must be a valid country code; changelog data is worldwide and identical regardless of country

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
event_typesarray

Comma-separated list of event types to filter by: added, removed, changed

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** daily (only daily granularity is supported)

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-apps-details

get-apps-details
Full Description

[apps] App Details Returns structured metadata for a given app from the iOS App Store or Google Play, including title, developer, category, pricing, description, icons and ratings.

Parameters (2 required, 6 optional)
Required
app_idstring

App ID or Bundle ID (if Store=apple and it is a string value than treat as Bundle ID) **Constraints:** is required and cannot be empty

storestring

Application store identifier

Options:googleappleunified
Optional
countrystring

Two-letter country code (e.g., 'us', 'gb'). **Constraints:** must be a valid two-letter country code

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Default: null
include_unpublished_appsboolean

Include unpublished apps in search results. Default is false

Default: null
languagestring

Language code for app details. **Constraints:** must be a supported language code

Default: null

Get-apps-downloads

get-apps-downloads
Full Description

[apps] App Downloads Returns the estimated Store Downloads for mobile apps across Google Play Store, Apple App Store, and both stores (“Unified”) over the given time frame.

Parameters (3 required, 4 optional)
Required
app_idstring

Unique application identifier. Google app IDs consist of letters, numbers, and dots (e.g., 'com.facebook.katana'), while Apple app IDs are numeric only (e.g., '447188370'). **Constraints:** is required and cannot be empty

countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww') **Constraints:** is required and cannot be empty, must be a valid two-letter country code

storestring

Application store identifier **Constraints:** either 'google', 'apple' or 'unified'

Options:googleappleunified
Optional
data_versionstring

Data version. Discriminated type defined with `data_version` query parameter. Bound via M:API.Common.Binders.ModelBindingContextExtensions.BindAndResolveDataVersion(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext,API.Requests.V5.BaseRequests.IDataVersionRequest). Subtypes:<list type="bullet"><item>API.Requests.V5.BaseRequests.ResolvedDataVersionBranch: in case `data_version` parameter is defined and correct (validated).</item><item>API.Requests.V5.BaseRequests.UnspecifiedDataVersionBranch: in case `data_version` parameter is missing or set to empty string. Uses `master` branch hash, no branch name specified.</item><item>API.Requests.V5.BaseRequests.InvalidDataVersionBranch: in case `data_version` parameter is defined but not correct (validation can't find name in validation list).</item></list> If user needs only API.Requests.V5.BaseRequests.IHasHash.Hash, they may use API.Requests.V5.BaseRequests.IHasHash type to check for that.

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Options:dailyweeklymonthly
Default: null

Get-apps-iab-categories

get-apps-iab-categories
Full Description

[apps] App IAB Categories Returns IAB 1.0, 2.0, and 3.0 category classifications for a given app from Google Play or the App Store. Categories are either declared by the developer or inferred by Similarweb. Useful for targeting, benchmarking, and content alignment

Parameters (2 required, 4 optional)
Required
app_idstring

App ID or Bundle ID (if Store=apple and it is a string value than treat as Bundle ID) **Constraints:** is required and cannot be empty

storestring

Application store identifier **Constraints:** either 'google' or 'apple'

Options:googleapple
Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** must be 'daily'. No other granularity is supported.

Default: null
iab_versionsarray

Comma separated list of Iab versions to retrieve. Available versions: 'v1','v2','v3'. Defaults to a list of all of them.

Default: null

Get-apps-install-penetration

get-apps-install-penetration
Full Description

[apps] App Install Penetration Returns the percentage of the devices in a country with the given app actively installed.

Parameters (2 required, 4 optional)
Required
app_idstring

Unique application identifier. Google app IDs consist of letters, numbers, and dots (e.g., 'com.facebook.katana'), while Apple app IDs are numeric only (e.g., '447188370'). **Constraints:** is required and cannot be empty

storestring

Application store identifier **Constraints:** supports only 'google'

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Options:dailyweeklymonthly
Default: null

Get-apps-ranks

get-apps-ranks
Full Description

[apps] App Ranks Returns historical ranking trends for a specific app across the Google Play and Apple App Store Top Charts.

Parameters (3 required, 7 optional)
Required
app_idstring

Unique application identifier. Google app IDs consist of letters, numbers, and dots (e.g., 'com.facebook.katana'), while Apple app IDs are numeric only (e.g., '447188370').

countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww') **Constraints:** is required and cannot be empty

storestring

Application store identifier **Constraints:** either 'google' or 'apple'

Options:googleapple
Optional
ascboolean

Orders the results by ascending or descending

Default: null
category_idsarray

*category_ids*: The category IDs for the app.

Default: null
devicesarray

*devices*: Options for apple store: iphone, ipad. For apple it defaults to: iphone, for google it defaults to: android.

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-apps-ratings

get-apps-ratings
Full Description

[apps] App Ratings Returns the average ratings, ratings counts and rating distribution for mobile apps across Google Play Store and Apple App Store.

Parameters (2 required, 4 optional)
Required
app_idstring

Unique application identifier. Google app IDs consist of letters, numbers, and dots (e.g., 'com.facebook.katana'), while Apple app IDs are numeric only (e.g., '447188370'). **Constraints:** is required and cannot be empty

storestring

Application store identifier **Constraints:** either 'google' or 'apple'

Options:googleapple
Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Options:dailyweeklymonthly
Default: null

Get-apps-retention

get-apps-retention
Full Description

[apps] App Retention Returns the percentage of users who used the app during the first 30 days after installation.

Parameters (2 required, 4 optional)
Required
app_idstring

Unique application identifier. Google app IDs consist of letters, numbers, and dots (e.g., 'com.facebook.katana'), while Apple app IDs are numeric only (e.g., '447188370'). **Constraints:** is required and cannot be empty

storestring

Application store identifier **Constraints:** supports only 'google'

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Default: null

Get-apps-revenue

get-apps-revenue
Full Description

[apps] App Revenue Return estimated revenue and ARPU for mobile apps across Google Play and the Apple App Store.

Parameters (2 required, 4 optional)
Required
app_idstring

Unique application identifier. Google app IDs consist of letters, numbers, and dots (e.g., 'com.facebook.katana'), while Apple app IDs are numeric only (e.g., '447188370').

storestring

Application store identifier **Constraints:** either 'google' or 'apple'

Options:googleappleunified
Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** must be 'monthly'. No other granularity is supported.

Default: null

Get-apps-search

get-apps-search
Full Description

[apps] App Search Returns a list of apps matching a search term across Google Play and Apple App Store with app details including title, publisher, and app ID.

Parameters (1 required, 4 optional)
Required
termstring

The term to search in the app stores

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Default: null
limitinteger

number of app result to return, default and max is 100

Default: null

Get-apps-sessions

get-apps-sessions
Full Description

[apps] App Sessions Returns the estimated Sessions Per User, Average Session Time Per Users and Total Sessions Time Per User for mobile apps across Google Play Store, Apple App Store, and both stores (“Unified”) over the given time frame.

Parameters (3 required, 4 optional)
Required
app_idstring

Unique application identifier. Google app IDs consist of letters, numbers, and dots (e.g., 'com.facebook.katana'), while Apple app IDs are numeric only (e.g., '447188370'). **Constraints:** is required and cannot be empty

countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww') **Constraints:** is required and cannot be empty, must be a valid two-letter country code

storestring

Application store identifier **Constraints:** either 'google', 'apple' or 'unified'

Options:googleappleunified
Optional
data_versionstring

Data version. Discriminated type defined with `data_version` query parameter. Bound via M:API.Common.Binders.ModelBindingContextExtensions.BindAndResolveDataVersion(Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingContext,API.Requests.V5.BaseRequests.IDataVersionRequest). Subtypes:<list type="bullet"><item>API.Requests.V5.BaseRequests.ResolvedDataVersionBranch: in case `data_version` parameter is defined and correct (validated).</item><item>API.Requests.V5.BaseRequests.UnspecifiedDataVersionBranch: in case `data_version` parameter is missing or set to empty string. Uses `master` branch hash, no branch name specified.</item><item>API.Requests.V5.BaseRequests.InvalidDataVersionBranch: in case `data_version` parameter is defined but not correct (validation can't find name in validation list).</item></list> If user needs only API.Requests.V5.BaseRequests.IHasHash.Hash, they may use API.Requests.V5.BaseRequests.IHasHash type to check for that.

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Options:dailyweeklymonthly
Default: null

Get-apps-technographics-sdks

get-apps-technographics-sdks
Full Description

[apps] App Sdks Returns SDKs associated with a particular app and the SDKs’ respective install data.

Parameters (2 required, 7 optional)
Required
app_idstring

Unique application identifier. Google app IDs consist of letters, numbers, and dots (e.g., 'com.facebook.katana'), while Apple app IDs are numeric only (e.g., '447188370').

storestring

Application store identifier **Constraints:** either 'google' or 'apple'

Options:googleapple
Optional
ascboolean

Orders the results by ascending or descending

Default: null
datestring

Returns a snapshot of all SDKs detected in the app on the specified date. If requested, also includes SDKs that were previously detected but were no longer present as of that date (i.e. uninstalled) **Constraints:** up to 37 months ago

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** support only daily granularity

Default: null
include_uninstalled_sdksboolean

If true we return both installed and uninstalled SDKs, otherwise only the SDKs currently installed in the app on 'date'

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-apps-top-charts

get-apps-top-charts
Full Description

[apps] Apps Top Charts Returns a ranked list of top apps from the iOS App Store or Google Play.

Parameters (3 required, 7 optional)
Required
category_idstring

*category_id*: The category ID for the top chart. **Constraints:** is required and cannot be empty

countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww') **Constraints:** is required and cannot be empty

storestring

Application store identifier **Constraints:** either 'google' or 'apple'

Options:googleapple
Optional
ascboolean

Orders the results by ascending or descending

Default: null
datestring

Date (format: YYYY-MM-DD). Default to the latest available top chart.

Default: null
devicestring

Device type for the app ranking **Constraints:** either iphone, ipad or android

Options:androidipadiphone
Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-aso-keyword-rank-history

get-aso-keyword-rank-history
Full Description

[apps] ASO Keyword Rank History Returns historical ASO keyword rankings, volume, and difficulty for a single app across up to 50 keywords. Supports processing states for newly submitted keywords and warnings for keywords where the app is not ranked.

Parameters (4 required, 6 optional)
Required
app_idstring

Unique application identifier. Google app IDs consist of letters, numbers, and dots (e.g., 'com.facebook.katana'), while Apple app IDs are numeric only (e.g., '447188370'). **Constraints:** is required, must be a single app id

countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww') **Constraints:** is required and cannot be empty, must be a valid two-letter country code

keywordsarray

Comma-separated list of keywords to analyze (max 50). **Constraints:** comma-separated list of up to 50 keywords

storestring

Application store identifier **Constraints:** either 'google' or 'apple'

Options:googleapple
Optional
ascboolean

Orders the results by ascending or descending **Constraints:** sort direction. Defaults to false (descending)

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** must be 'daily'

Default: null
languagestring

Language code for keyword analysis. Defaults to the primary language for the selected store and country. **Constraints:** optional language code for the selected store and country

Default: null
limitinteger

Page size. Default is 100. Values above 100 are capped at 100, not rejected. **Constraints:** between 1 and 100. Defaults to 100

Default: null

Get-aso-top-ranked-keywords

get-aso-top-ranked-keywords
Full Description

[apps] ASO Top Ranked Keywords Returns keywords an app ranks well for in a store, country, and language over time. Each row is one qualifying keyword on one day: date, keyword, rank, plus requested metrics (volume, difficulty). Rank is always returned. Supports rank_limit (default 50, max 250), volume_min, and difficulty_max filters.

Parameters (3 required, 8 optional)
Required
app_idstring

Unique application identifier. Google app IDs consist of letters, numbers, and dots (e.g., 'com.facebook.katana'), while Apple app IDs are numeric only (e.g., '447188370'). **Constraints:** is required, must be a single app id

countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww') **Constraints:** is required and cannot be empty, must be a valid two-letter country code

storestring

Application store identifier **Constraints:** either 'google' or 'apple'

Options:googleapple
Optional
ascboolean

Orders the results by ascending or descending **Constraints:** sort in ascending order when true, descending when false. Defaults to ascending

Default: null
difficulty_maxinteger

Maximum difficulty filter (10-100). Only keywords with difficulty <= this value are returned. **Constraints:** optional difficulty ceiling, between 10 and 100

Default: null
effective_rank_limitinteger
Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** must be 'daily'

Default: null
languagestring

Language code for keyword analysis. Defaults to the primary language for the selected store and country. **Constraints:** optional language code for the selected store and country

Default: null
limitinteger

Page size. Default is 100. Values above 100 are capped at 100, not rejected. **Constraints:** between 1 and 100. Defaults to 100

Default: null

Get-brands-sales-performance

get-brands-sales-performance
Full Description

[shopper] Brand Sales Performance Returns time-series sales performance data for a specific brand within a category on Amazon.

General Constraints:

{
  "share_metrics": "share metrics are optional"
}
Parameters (3 required, 3 optional)
Required
brandstring

Brand name. Use brand search or top brands endpoints to discover available brands for your domain

categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain **Constraints:** domain, category, and brand are required

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'weekly', 'monthly'

Options:monthlyweekly
Default: null

Get-brands-sales-performance-agg

get-brands-sales-performance-agg
Full Description

[shopper] Brand Sales Performance Returns time-series sales performance data for a specific brand within a category on Amazon.

General Constraints:

{
  "share_metrics": "share metrics are optional"
}
Parameters (3 required, 3 optional)
Required
brandstring

Brand name. Use brand search or top brands endpoints to discover available brands for your domain

categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain **Constraints:** domain, category, and brand are required

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'weekly', 'monthly'

Options:monthlyweekly
Default: null

Get-brands-search

get-brands-search
Full Description

[shopper] Search Brands Returns matching e-commerce brands with their units sold for a given query string.

Parameters (2 required, 5 optional)
Required
domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain **Constraints:** Must be a valid e-commerce domain (e.g., amazon.com)

search_termstring

The search term to find matching brands. Case-insensitive. Partial matches are supported **Constraints:** The search term to find matching brands

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-brands-top-competitors

get-brands-top-competitors
Full Description

[shopper] Brands Top Competitors Returns time-series data of competitor brands with the highest audience overlap, ranked by affinity to a given brand within a category.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)"
}
Parameters (3 required, 5 optional)
Required
brandstring

Brand name. Use brand search or top brands endpoints to discover available brands for your domain

categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain **Constraints:** domain, category, and brand are required

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'weekly', 'monthly'

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-brands-top-competitors-agg

get-brands-top-competitors-agg
Full Description

[shopper] Brands Top Competitors Returns aggregated data of competitor brands with the highest audience overlap, ranked by affinity to a given brand within a category.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)"
}
Parameters (3 required, 5 optional)
Required
brandstring

Brand name. Use brand search or top brands endpoints to discover available brands for your domain

categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain **Constraints:** domain, category, and brand are required

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'weekly', 'monthly'

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-brands-top-keywords

get-brands-top-keywords
Full Description

[shopper] Brand Top Keywords Returns list of top on-site search keywords for a brand, ranked by selected metrics.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (3 required, 5 optional)
Required
brandstring

Brand name. Use brand search or top brands endpoints to discover available brands for your domain

categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'monthly', 'weekly' granularity (for date resolution)

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-brands-top-keywords-agg

get-brands-top-keywords-agg
Full Description

[shopper] Brand Top Keywords Returns list of top on-site search keywords for a brand, ranked by selected metrics.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (3 required, 5 optional)
Required
brandstring

Brand name. Use brand search or top brands endpoints to discover available brands for your domain

categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'monthly', 'weekly' granularity (for date resolution)

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-brands-top-products

get-brands-top-products
Full Description

[shopper] Brand Top Products Returns list of top-performing products for a specific brand, ranked by selected metrics.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (3 required, 5 optional)
Required
brandstring

Brand name. Use brand search or top brands endpoints to discover available brands for your domain

categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain **Constraints:** domain, category, and brand are required

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'weekly', 'monthly'

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-brands-top-products-agg

get-brands-top-products-agg
Full Description

[shopper] Brand Top Products Returns list of top-performing products for a specific brand, ranked by selected metrics.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (3 required, 5 optional)
Required
brandstring

Brand name. Use brand search or top brands endpoints to discover available brands for your domain

categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain **Constraints:** domain, category, and brand are required

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'weekly', 'monthly'

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-categories-performance

get-categories-performance
Full Description

[shopper] Category Performance Returns time-series on-site search performance metrics for a category over the selected time period.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (2 required, 3 optional)
Required
categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'monthly', 'weekly' granularity (for date resolution)

Options:monthlyweekly
Default: null

Get-categories-performance-agg

get-categories-performance-agg
Full Description

[shopper] Category Performance Returns time-series on-site search performance metrics for a category over the selected time period.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (2 required, 3 optional)
Required
categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'monthly', 'weekly' granularity (for date resolution)

Options:monthlyweekly
Default: null

Get-categories-sales-performance

get-categories-sales-performance
Full Description

[shopper] Category Sales Performance Returns time-series sales performance data for a specific category on Amazon.

Parameters (2 required, 3 optional)
Required
categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain **Constraints:** domain and category are required

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'weekly', 'monthly'

Options:monthlyweekly
Default: null

Get-categories-sales-performance-agg

get-categories-sales-performance-agg
Full Description

[shopper] Category Sales Performance Returns time-series sales performance data for a specific category on Amazon.

Parameters (2 required, 3 optional)
Required
categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain **Constraints:** domain and category are required

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'weekly', 'monthly'

Options:monthlyweekly
Default: null

Get-categories-search

get-categories-search
Full Description

[shopper] Search Categories Returns matching e-commerce categories with their hierarchy information for a given query string.

General Constraints:

{
  "query": "The search term to find matching categories"
}
Parameters (2 required, 6 optional)
Required
domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain **Constraints:** Must be a valid e-commerce domain (e.g., amazon.com)

search_termstring

The search term to find matching categories. Case-insensitive. Partial matches are supported

Optional
ascboolean

Orders the results by ascending or descending

Default: null
children_depthinteger

The depth of children categories to include in the response (default: 0). Non-negative integer. Note: Higher depth values may significantly increase response size **Constraints:** Non-negative integer specifying how many levels of child categories to include

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-categories-top-brands

get-categories-top-brands
Full Description

[shopper] Category Top Brands Returns list of top-performing brands within a category, ranked by selected metrics.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (2 required, 5 optional)
Required
categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain **Constraints:** domain and category are required

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'weekly', 'monthly'

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-categories-top-brands-agg

get-categories-top-brands-agg
Full Description

[shopper] Category Top Brands Returns list of top-performing brands within a category, ranked by selected metrics.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (2 required, 5 optional)
Required
categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain **Constraints:** domain and category are required

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'weekly', 'monthly'

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-categories-top-keywords

get-categories-top-keywords
Full Description

[shopper] Category Top Keywords Returns list of top on-site search keywords in a category, ranked by selected metrics.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (2 required, 5 optional)
Required
categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'monthly', 'weekly' granularity (for date resolution)

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-categories-top-keywords-agg

get-categories-top-keywords-agg
Full Description

[shopper] Category Top Keywords Returns list of top on-site search keywords in a category, ranked by selected metrics.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (2 required, 5 optional)
Required
categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'monthly', 'weekly' granularity (for date resolution)

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-categories-top-products

get-categories-top-products
Full Description

[shopper] Category Top Products Returns list of top products in a category, ranked by selected metrics.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (2 required, 5 optional)
Required
categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'monthly', 'weekly' granularity (for date resolution)

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-categories-top-products-agg

get-categories-top-products-agg
Full Description

[shopper] Category Top Products Returns list of top products in a category, ranked by selected metrics.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (2 required, 5 optional)
Required
categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'monthly', 'weekly' granularity (for date resolution)

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-clicks-share

get-clicks-share
Full Description

[shopper] Brand Clicks Share Returns time-series on-site search clicks share data for a brand within a category.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (3 required, 3 optional)
Required
brandstring

Brand name. Use brand search or top brands endpoints to discover available brands for your domain

categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'monthly', 'weekly' granularity (for date resolution)

Options:monthlyweekly
Default: null

Get-clicks-share-agg

get-clicks-share-agg
Full Description

[shopper] Brand Clicks Share Returns time-series on-site search clicks share data for a brand within a category.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (3 required, 3 optional)
Required
brandstring

Brand name. Use brand search or top brands endpoints to discover available brands for your domain

categorystring

Amazon category ID (numeric string, e.g., '679182011'). Category IDs are domain-specific and cannot be used across different Amazon domains. Use the category search endpoint to find valid IDs for your domain

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'monthly', 'weekly' granularity (for date resolution)

Options:monthlyweekly
Default: null

Get-custom-industries-describe

get-custom-industries-describe
Full Description

[web] Get list of custom industries. Get list of custom industries.

Parameters (0 required, 2 optional)
Optional
custom_industrystring

Custom industry ID in GUID format

Default: null
include_sharedboolean

'true' to include shared custom industries. Default is 'false'

Default: null

Get-demand-search-trends

get-demand-search-trends
Full Description

[web] Search Trends Returns search volume trends for keywords linked to a topic seed or a keyword group, both as an aggregate across all keywords and broken down per individual keyword over time.

Parameters (1 required, 4 optional)
Required
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly for the last 3 months, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
keyword_groupstring

Keyword group ID in GUID format. Mutually exclusive with 'topic'. **Constraints:** Either 'topic' or 'keyword_group' must be provided, but not both

Default: null

Get-demand-search-trends-aggregated

get-demand-search-trends-aggregated
Full Description

[web] Search Trends Aggregated Returns search volume trends for keywords linked to a topic seed or a keyword group, both as an aggregate across all keywords and broken down per individual keyword over time.

Parameters (1 required, 4 optional)
Required
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly for the last 3 months, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
keyword_groupstring

Keyword group ID in GUID format. Mutually exclusive with 'topic'. **Constraints:** Either 'topic' or 'keyword_group' must be provided, but not both

Default: null

Get-demand-search-trends-keywords

get-demand-search-trends-keywords
Full Description

[web] Search Trends Keywords Returns search volume trends for keywords linked to a topic seed or a keyword group, both as an aggregate across all keywords and broken down per individual keyword over time.

Parameters (1 required, 4 optional)
Required
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly for the last 3 months, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
keyword_groupstring

Keyword group ID in GUID format. Mutually exclusive with 'topic'. **Constraints:** Either 'topic' or 'keyword_group' must be provided, but not both

Default: null

Get-demand-search-trends-keywords-aggregated

get-demand-search-trends-keywords-aggregated
Full Description

[web] Search Trends Keywords Aggregated Returns search volume trends for keywords linked to a topic seed or a keyword group, both as an aggregate across all keywords and broken down per individual keyword over time.

Parameters (1 required, 4 optional)
Required
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly for the last 3 months, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
keyword_groupstring

Keyword group ID in GUID format. Mutually exclusive with 'topic'. **Constraints:** Either 'topic' or 'keyword_group' must be provided, but not both

Default: null

Get-gen-ai-campaign-analysis-citations-aggregated

get-gen-ai-campaign-analysis-citations-aggregated
Full Description

[ai_tracker] GenAI Citation Analysis (URL-level) GenAI Citation Analysis API (URL-level) — citation landscape for a Brand Visibility campaign at URL granularity. One row per cited URL, period-aggregated over start_date–end_date. Rows with zero citations in the queried period are omitted. Describe: uses MCP tool get-gen-ai-campaigns (GET /v5/gen-ai-campaign-analysis/prompts/describe) for shared campaign metadata. No date/time-series dimension — rows are period-aggregated only; no granularity parameter. No mtd — data refreshes daily via arbitrary date range. domain filter is exact match on the normalized domain string (no subdomain rollup). influence_score field name matches the live Pro UI label ("Influence Score"), not pro-docs' internal "Source Authority" name. Workflows: (1) drill-down from prompts scoreboard via prompts filter; (2) own-domain vs third-party split via domain filter; (3) bulk export with limit=1000. Paginate until page length < limit or data is empty — no total_rows.

General Constraints:

{
  "country": "Not supported \u2014 returns 400 if passed. Country is fixed per campaign.",
  "granularity": "Not supported \u2014 returns 400 if passed. Rows are period-aggregated only (no time bucketing)."
}
Parameters (1 required, 6 optional)
Required
campaign_idstring

Unique campaign identifier (UUID format)

Optional
ascboolean

Sort direction: true for ascending, false for descending. Default is false (descending). **Constraints:** true or false. Default: false (descending).

Default: null
domainstring

Filter to URLs belonging to a cited domain. Exact match on the normalized domain string returned in the domain response field (case-insensitive; no subdomain rollup — domain=nike.com does not return shop.nike.com). **Constraints:** Optional. Exact match on normalized domain string (case-insensitive; no subdomain rollup).

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Optional. Defaults to the campaign's latest scraping date. Inclusive aggregation window (YYYY-MM-DD).

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
limitinteger

Page size. Default is 100. Valid range is 1–1,000. **Constraints:** 1-1000, default: 100. Paginate until page length < limit or data is empty (no total_rows).

Default: null
llmsarray

Filter by LLM providers: chatgpt, google_ai_mode, perplexity, gemini (comma-separated list) **Constraints:** Filter by LLM providers: chatgpt, google_ai_mode, perplexity, gemini (comma-separated list)

Default: null

Get-gen-ai-campaign-analysis-prompts

get-gen-ai-campaign-analysis-prompts
Full Description

[ai_tracker] Get AI tracker prompts data Returns daily prompts data with responses, brands mentioned, citations, topics, and sentiment analysis

Parameters (1 required, 7 optional)
Required
campaign_idstring

Unique campaign identifier (UUID format)

Optional
ascboolean

Orders the results by ascending (true) or descending (false). Default is ascending (true)

Default: null
brandsarray

Filter by brands mentioned in prompts (comma-separated list)

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Optional as a pair with start_date; if either is provided, both are required. When both are omitted, defaults to the latest scrape day. Supported date range spans from the campaign's first scraping date to its last scraping date, up to 90 days (inclusive)

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only 'daily' granularity; start_date and end_date may span up to 90 days (inclusive)

Default: null
limitinteger

Sets how many results to return. Default is 100. Must be between 1 and 1200 **Constraints:** 1-1200, default: 100

Default: null
llmsarray

Filter by LLM providers: chatgpt, google_ai_mode, perplexity, gemini (comma-separated list)

Default: null

Get-gen-ai-campaign-analysis-prompts-aggregated

get-gen-ai-campaign-analysis-prompts-aggregated
Full Description

[ai_tracker] Get AI tracker aggregated prompts scoreboard GenAI Prompts Aggregated API — period-aggregated per-prompt metrics for a Brand Visibility campaign (one row per prompt x LLM).

Use for weekly scoreboards, prompt monitoring, and competitive prompt analysis.

Pair with GET .../visibility?prompt_id=... for competitive drill-down on specific prompts (full brand x time breakdown). Use GET .../prompts for daily response text and per-answer citations (metrics=citations). Use GET .../citations?prompt_ids=p_1,p_2,... for multi-prompt URL rollups and source category analysis.

Describe: uses MCP tool get-gen-ai-campaigns (GET .../prompts/describe) for shared campaign metadata.

Workflows: 1. Weekly scoreboard (flat metrics only, agent-friendly): GET .../prompts/aggregated?campaign_id={id}&metrics=visibility,competitors_avg_visibility,pop_change&sort=visibility&asc=false 2. Competitor gap analysis (nested brand detail): GET .../prompts/aggregated?campaign_id={id}&metrics=visibility,brand_visibility,competitors_avg_visibility&sort=visibility&asc=true 3. Win/lose classification (flat only): GET .../prompts/aggregated?campaign_id={id}&metrics=visibility,competitors_avg_visibility 4. Competitive drill-down (identify, then drill into visibility endpoint): GET .../prompts/aggregated?campaign_id={id}&metrics=visibility,brand_visibility,pop_change&sort=visibility&asc=true (then GET .../visibility?campaign_id={id}&prompt_id={id} for brand x time breakdown) 5. Multi-LLM pivot: GET .../prompts/aggregated?campaign_id={id} (omit llms; pivot by llm_source)

Pagination: limit default 100, max 1000; sort before page; no total_rows. offset + limit must not exceed 100,000 rows; requests beyond that window return an error.

Parameters (1 required, 6 optional)
Required
campaign_idstring

Unique campaign identifier (UUID format)

Optional
ascboolean

Orders the results by ascending (true) or descending (false). Default is descending (false).

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Optional; required together with start_date. When both are omitted, defaults to the campaign's latest scrape day. Range spans the campaign's first to last scraping date, up to 90 days (inclusive)

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only 'daily' granularity; start_date and end_date may span up to 90 days (inclusive)

Default: null
limitinteger

Sets how many results to return. Default is 100. Must be between 1 and 1200 **Constraints:** 1-1200, default: 100

Default: null
llmsarray

Filter by LLM providers: chatgpt, google_ai_mode, perplexity, gemini (comma-separated list)

Default: null

Get-gen-ai-campaign-analysis-visibility

get-gen-ai-campaign-analysis-visibility
Full Description

[ai_tracker] GenAI Brand Visibility over time (entity x date bucket) Returns campaign-scoped brand visibility and mention-share data for AI Brand Visibility campaigns. GET /v5/gen-ai-campaign-analysis/visibility — time-series with daily or weekly granularity. Row grain: one row per entity per date bucket. Filters narrow the response pool but do not change row grain. Identity on every row: entity_name, entity_type (brand), entity_role (primary | competitor | other), parent (campaign entity; entity rows self-parent). Workflow: (1) Discover valid campaign_id, brands, topics, LLMs, date bounds, and supported metrics via MCP tool get-gen-ai-campaigns (GET /v5/gen-ai-campaign-analysis/prompts/describe). (2) Call the data endpoint with campaign_id and optional filters. (3) Paginate by incrementing offset until a page returns fewer rows than limit. Defaults: omitting both dates returns the most recent 7 calendar days ending on the latest scrape day. Absolute YYYY-MM-DD only (no relative or YYYY-MM values) — relative date keywords are not supported. Max range 90 days. Metrics are ratios 0–1 (0.71 = 71%). Zero-activity entity/date combinations return rows with visibility=0 and mention_share=0. LLM filter aggregates across selected models into one row per entity × date. competitive_set_brands=true returns entity_role=competitor only. Credits: time-series metrics at 0.05 credits/row/metric.

Parameters (1 required, 8 optional)
Required
campaign_idstring

Unique campaign identifier (UUID format) **Constraints:** Required. Brand Visibility campaign id (UUID). Discover ids via MCP tool get-gen-ai-campaigns (GET /v5/gen-ai-campaign-analysis/prompts/describe).

Optional
ascboolean

Sort direction: true for ascending, false for descending. Default is false (descending). **Constraints:** true or false. Default: false (descending).

Default: null
brandsarray

Optional. Comma-separated configured entity names (OR semantics). Case-insensitive full-name match against entity_name. Unknown values are silently ignored. Valid values are listed per campaign by MCP tool get-gen-ai-campaigns (GET /v5/gen-ai-campaign-analysis/prompts/describe). **Constraints:** Optional. Comma-separated configured entity names (OR semantics). Case-insensitive full-name match against entity_name. Unknown values are silently ignored. Valid values are listed per campaign by MCP tool get-gen-ai-campaigns (GET /v5/gen-ai-campaign-analysis/prompts/describe).

Default: null
competitive_set_brandsboolean

Optional. When true, return only entity_role=competitor rows (exclude primary). Default is false. **Constraints:** Optional. When true, return only entity_role=competitor rows (exclude primary). Default is false.

Default: null
end_datestring

Optional. Absolute YYYY-MM-DD only (no relative or YYYY-MM values). May be provided independently of start_date. When both are omitted, defaults to the campaign's latest scrape day. When only end_date is provided, defaults to 7 calendar days ending on end_date. Must fall inside the campaign scraping window and span at most 90 inclusive days. **Constraints:** Optional. Absolute YYYY-MM-DD only (no relative or YYYY-MM values). May be provided independently of start_date. When both are omitted, defaults to the campaign's latest scrape day. When only end_date is provided, defaults to 7 calendar days ending on end_date. Must fall inside the campaign scraping window and span at most 90 inclusive days.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** Optional. Bucket size of the returned series: daily or weekly. When omitted, defaults to daily for date ranges under 90 inclusive days and weekly for ranges of 90 inclusive days or longer. Explicit weekly requires at least 14 inclusive days; otherwise HTTP 400. When weekly is requested with both dates omitted, the default window is 14 days.

Options:dailyweekly
Default: null
limitinteger

Page size. Default is 100. Valid range is 1–1000. **Constraints:** 1-1000, default: 100. Rows are entity x date bucket, so one page is not a complete time series. Increment offset until a page returns fewer rows than limit.

Default: null
llmsarray

Filter by LLM providers: chatgpt, google_ai_mode, perplexity, gemini (comma-separated list) **Constraints:** Optional. Comma-separated LLM providers (OR semantics): chatgpt, gemini, perplexity, google_ai_mode. Metrics aggregate across selected models into one row. Unknown values are silently ignored. Omitted defaults to all completed campaign LLMs.

Default: null

Get-gen-ai-campaign-analysis-visibility-aggregated

get-gen-ai-campaign-analysis-visibility-aggregated
Full Description

[ai_tracker] GenAI Brand Visibility aggregated (entity) Returns campaign-scoped brand visibility and mention-share data for AI Brand Visibility campaigns. GET /v5/gen-ai-campaign-analysis/visibility/aggregated — period-aggregated with optional pop_change. Row grain: one row per entity. Filters narrow the response pool but do not change row grain. Identity on every row: entity_name, entity_type (brand), entity_role (primary | competitor | other), parent (campaign entity; entity rows self-parent). Workflow: (1) Discover valid campaign_id, brands, topics, LLMs, date bounds, and supported metrics via MCP tool get-gen-ai-campaigns (GET /v5/gen-ai-campaign-analysis/prompts/describe). (2) Call the data endpoint with campaign_id and optional filters. (3) Paginate by incrementing offset until a page returns fewer rows than limit. Defaults: omitting both dates returns the most recent 7 calendar days ending on the latest scrape day. Absolute YYYY-MM-DD only (no relative or YYYY-MM values) — relative date keywords are not supported. Max range 90 days. Metrics are ratios 0–1 (0.71 = 71%). Zero-activity entities return rows with visibility=0 and mention_share=0. LLM filter aggregates across selected models into one row per entity. competitive_set_brands=true returns entity_role=competitor only. Credits: aggregated at 1.0 credits/row/metric.

General Constraints:

{
  "granularity": "Not supported \u2014 returns 400 if passed. Rows are period-aggregated only (no time bucketing)."
}
Parameters (1 required, 7 optional)
Required
campaign_idstring

Unique campaign identifier (UUID format) **Constraints:** Required. Brand Visibility campaign id (UUID). Discover ids via MCP tool get-gen-ai-campaigns (GET /v5/gen-ai-campaign-analysis/prompts/describe).

Optional
ascboolean

Sort direction: true for ascending, false for descending. Default is false (descending). **Constraints:** true or false. Default: false (descending).

Default: null
brandsarray

Optional. Comma-separated configured entity names (OR semantics). Case-insensitive full-name match against entity_name. Unknown values are silently ignored. Valid values are listed per campaign by MCP tool get-gen-ai-campaigns (GET /v5/gen-ai-campaign-analysis/prompts/describe). **Constraints:** Optional. Comma-separated configured entity names (OR semantics). Case-insensitive full-name match against entity_name. Unknown values are silently ignored. Valid values are listed per campaign by MCP tool get-gen-ai-campaigns (GET /v5/gen-ai-campaign-analysis/prompts/describe).

Default: null
competitive_set_brandsboolean

Optional. When true, return only entity_role=competitor rows (exclude primary). Default is false. **Constraints:** Optional. When true, return only entity_role=competitor rows (exclude primary). Default is false.

Default: null
end_datestring

Optional. Absolute YYYY-MM-DD only (no relative or YYYY-MM values). May be provided independently of start_date. When both are omitted, defaults to the campaign's latest scrape day. When only end_date is provided, defaults to 7 calendar days ending on end_date. Must fall inside the campaign scraping window and span at most 90 inclusive days. **Constraints:** Optional. Absolute YYYY-MM-DD only (no relative or YYYY-MM values). May be provided independently of start_date. When both are omitted, defaults to the campaign's latest scrape day. When only end_date is provided, defaults to 7 calendar days ending on end_date. Must fall inside the campaign scraping window and span at most 90 inclusive days.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
limitinteger

Page size. Default is 100. Valid range is 1–1000. **Constraints:** 1-1000, default: 100. Increment offset until a page returns fewer rows than limit.

Default: null
llmsarray

Filter by LLM providers: chatgpt, google_ai_mode, perplexity, gemini (comma-separated list) **Constraints:** Optional. Comma-separated LLM providers (OR semantics): chatgpt, gemini, perplexity, google_ai_mode. Metrics aggregate across selected models into one row. Unknown values are silently ignored. Omitted defaults to all completed campaign LLMs.

Default: null

Get-gen-ai-campaigns

get-gen-ai-campaigns
Full Description

[ai_tracker]

Parameters (0 required, 1 optional)
Optional
campaign_idstring
Default: null

Get-gen-ai-research-brand-search

get-gen-ai-research-brand-search
Full Description

[autocomplete] Brand Search Catalog utility for Brand Research brand entry, returns a list of suggested brands based on brand name.

Parameters (0 required, 2 optional)
Optional
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
limitinteger

Maximum number of brand suggestions to return. Defaults to 5 and supports values from 1 to 20 **Constraints:** must be between 1 and 20

Default: null

Get-industry-demographics-age-distribution

get-industry-demographics-age-distribution
Full Description

[web] Industry Domains Age Distribution Returns per-domain age distribution shares for sites in a category.

Parameters (0 required, 9 optional)
Optional
ascboolean

Orders the results by ascending or descending

Default: null
categorystring

Website industry category identifier **Constraints:** Exactly one of 'category' or 'custom_industry' must be provided

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
custom_industrystring

Custom industry ID in GUID format **Constraints:** Exactly one of 'category' or 'custom_industry' must be provided

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity

Default: null
limitinteger

Sets how many results to return.

Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-industry-demographics-age-distribution-agg

get-industry-demographics-age-distribution-agg
Full Description

[web] Industry Age Distribution Returns industry-level age distribution shares for a category.

Parameters (0 required, 6 optional)
Optional
categorystring

Website industry category identifier **Constraints:** Exactly one of 'category' or 'custom_industry' must be provided

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
custom_industrystring

Custom industry ID in GUID format **Constraints:** Exactly one of 'category' or 'custom_industry' must be provided

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity

Default: null

Get-industry-demographics-describe

get-industry-demographics-describe
Full Description

[web] Industry Demographics Valid Values Returns supported countries, categories, and date ranges for industry demographics endpoints.

Get-industry-demographics-gender-shares

get-industry-demographics-gender-shares
Full Description

[web] Industry Domains Gender Shares Returns per-domain male and female audience shares for sites in a category.

Parameters (0 required, 9 optional)
Optional
ascboolean

Orders the results by ascending or descending

Default: null
categorystring

Website industry category identifier **Constraints:** Exactly one of 'category' or 'custom_industry' must be provided

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
custom_industrystring

Custom industry ID in GUID format **Constraints:** Exactly one of 'category' or 'custom_industry' must be provided

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity

Default: null
limitinteger

Sets how many results to return.

Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-industry-demographics-gender-shares-agg

get-industry-demographics-gender-shares-agg
Full Description

[web] Industry Gender Shares Returns industry-level male and female audience shares for a category.

Parameters (0 required, 7 optional)
Optional
categorystring

Website industry category identifier **Constraints:** Exactly one of 'category' or 'custom_industry' must be provided

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
custom_industrystring

Custom industry ID in GUID format **Constraints:** Exactly one of 'category' or 'custom_industry' must be provided

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity

Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-industry-unique-users

get-industry-unique-users
Full Description

[web] Industry Unique Users Returns monthly unique users for a built-in industry category or a custom industry.

Parameters (0 required, 7 optional)
Optional
categorystring

Website industry category identifier **Constraints:** Exactly one of 'category' or 'custom_industry' must be provided

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
custom_industrystring

Custom industry ID in GUID format **Constraints:** Exactly one of 'category' or 'custom_industry' must be provided

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity

Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-industry-unique-users-describe

get-industry-unique-users-describe
Full Description

[web] Industry Unique Users Valid Values Returns supported countries, categories, and date ranges for the industry unique users endpoint.

Get-keywords-latest-agg

get-keywords-latest-agg
Full Description

[web] Website Keywords Returns the keywords driving search clicks to a specified domain for the latest available period only (last month or last 28 days).

Parameters (1 required, 8 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
branded_typestring

Branded keyword type - 'all', 'branded', or 'non_branded'

Options:allbrandednon_branded
Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity for last month, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
keywords_filter_rulesarray

Filter rules for keywords as a URL-encoded JSON array. Each rule specifies whether to include/exclude keywords and how to match them (exact or phrase). Structure: {[{"type": "include | exclude", "match_type": "exact | phrase", "keywords": ["keyword1", "keyword2"]}]}. Example: {[{"type": "exclude", "match_type": "phrase", "keywords": ["brand name", "company"]}, {"type": "include", "match_type": "exact", "keywords": ["marketing"]}]}

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-keywords-overview

get-keywords-overview
Full Description

[web] Keywords Overview Returns comprehensive keyword performance metrics over time including search volume, clicks broken down by type (organic, paid, PLA), difficulty, competition, CPC, and user intent data.

Parameters (1 required, 7 optional)
Required
keywordstring

A single keyword or name of a keyword group to analyze

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly for the last 3 months, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
is_keyword_groupboolean

A boolean flag to specify if a keyword group is provided or a single keyword. Default is 'false'

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-keywords-performance

get-keywords-performance
Full Description

[shopper] Keyword Performance Returns time-series on-site search performance data for a specific keyword on Amazon.

Parameters (2 required, 3 optional)
Required
domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain **Constraints:** domain and keyword are required

keywordstring

Search keyword or keyword ID. Can be a plain text keyword (e.g., 'laptop') or a keyword ID if known. Keywords are case-insensitive for matching. Use keyword search or top keywords endpoints to discover available keywords

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'weekly', 'monthly'

Options:monthlyweekly
Default: null

Get-keywords-performance-agg

get-keywords-performance-agg
Full Description

[shopper] Keyword Performance Returns time-series on-site search performance data for a specific keyword on Amazon.

Parameters (2 required, 3 optional)
Required
domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain **Constraints:** domain and keyword are required

keywordstring

Search keyword or keyword ID. Can be a plain text keyword (e.g., 'laptop') or a keyword ID if known. Keywords are case-insensitive for matching. Use keyword search or top keywords endpoints to discover available keywords

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'weekly', 'monthly'

Options:monthlyweekly
Default: null

Get-keywords-seo-overview

get-keywords-seo-overview
Full Description

[web] Website Keywords Returns an overview of keyword search clicks for a specified domain over each time period.

Parameters (1 required, 8 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
branded_typestring

Branded keyword type - 'all', 'branded', or 'non_branded'

Options:allbrandednon_branded
Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly for the last 3 months, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
keywords_filter_rulesarray

Filter rules for keywords as a URL-encoded JSON array. Each rule specifies whether to include/exclude keywords and how to match them (exact or phrase). Structure: {[{"type": "include | exclude", "match_type": "exact | phrase", "keywords": ["keyword1", "keyword2"]}]}. Example: {[{"type": "exclude", "match_type": "phrase", "keywords": ["brand name", "company"]}, {"type": "include", "match_type": "exact", "keywords": ["marketing"]}]}

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-keywords-top-brands

get-keywords-top-brands
Full Description

[shopper] Keyword Top Brands Returns list of top brands for an on-site search keyword, ranked by selected metrics.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (2 required, 5 optional)
Required
domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

keywordstring

Search keyword or keyword ID. Can be a plain text keyword (e.g., 'laptop') or a keyword ID if known. Keywords are case-insensitive for matching. Use keyword search or top keywords endpoints to discover available keywords

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'monthly', 'weekly' granularity (for date resolution)

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-keywords-top-brands-agg

get-keywords-top-brands-agg
Full Description

[shopper] Keyword Top Brands Returns list of top brands for an on-site search keyword, ranked by selected metrics.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (2 required, 5 optional)
Required
domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

keywordstring

Search keyword or keyword ID. Can be a plain text keyword (e.g., 'laptop') or a keyword ID if known. Keywords are case-insensitive for matching. Use keyword search or top keywords endpoints to discover available keywords

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'monthly', 'weekly' granularity (for date resolution)

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-keywords-top-products

get-keywords-top-products
Full Description

[shopper] Keyword Top Products Returns list of top products for an on-site search keyword, ranked by selected metrics.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (2 required, 5 optional)
Required
domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

keywordstring

Search keyword or keyword ID. Can be a plain text keyword (e.g., 'laptop') or a keyword ID if known. Keywords are case-insensitive for matching. Use keyword search or top keywords endpoints to discover available keywords

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'monthly', 'weekly' granularity (for date resolution)

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-keywords-top-products-agg

get-keywords-top-products-agg
Full Description

[shopper] Keyword Top Products Returns list of top products for an on-site search keyword, ranked by selected metrics.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (2 required, 5 optional)
Required
domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

keywordstring

Search keyword or keyword ID. Can be a plain text keyword (e.g., 'laptop') or a keyword ID if known. Keywords are case-insensitive for matching. Use keyword search or top keywords endpoints to discover available keywords

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'monthly', 'weekly' granularity (for date resolution)

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-lead-enrichment-company

get-lead-enrichment-company
Full Description

[web] Enrich Company Search for a company by name and enrich it with firmographic data, products & services, subsidiaries, and competitors.

Parameters (0 required, 5 optional)
Optional
company_namestring

Company name to search for and enrich (used when domain is not provided) **Constraints:** at least one parameter is required `domain` or `company-name`

Default: null
domainstring

Website domain to enrich (e.g., 'similarweb.com')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Default: null

Get-lead-enrichment-website

get-lead-enrichment-website
Full Description

[web] Enrich Website Enrich a website domain with firmographic data, products & services, subsidiaries, and competitors.

Parameters (0 required, 5 optional)
Optional
company_namestring

Company name to search for and enrich (used when domain is not provided)

Default: null
domainstring

Website domain to enrich (e.g., 'similarweb.com') **Constraints:** at least one parameter is required `domain` or `company-name`

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Default: null

Get-pages-leading-folders-agg

get-pages-leading-folders-agg
Full Description

[web] Folders Returns a list of leading folders for a domain and share per folder.

Parameters (1 required, 7 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
limitinteger

Sets how many results to return.

Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-pages-popular-pages-agg

get-pages-popular-pages-agg
Full Description

[web] Popular Pages Returns a list of pages receiving incoming traffic and traffic share per page.

Parameters (1 required, 7 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
classifystring

Set to one of the following values: 'evergreen' (page exists in all months), 'new', 'trending'. default is 'all' **Constraints:** supported only in monthly granularity; daily granularity supports 'All' value only

Options:allevergreennewtrending
Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-products-sales-performance

get-products-sales-performance
Full Description

[shopper] Product Sales Performance Returns time-series sales performance data for a specific product (ASIN) on Amazon.

Parameters (2 required, 3 optional)
Required
asinstring

Amazon Standard Identification Number. Must be exactly 10 characters (uppercase alphanumeric only). Format: 10 uppercase letters and/or numbers (e.g., 'B0DLFVP6YM'). ASINs are Amazon-specific and cannot be used across different Amazon domains **Constraints:** ASIN must be exactly 10 characters (uppercase alphanumeric)

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain **Constraints:** domain and ASIN are required

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'weekly', 'monthly'

Options:monthlyweekly
Default: null

Get-products-sales-performance-agg

get-products-sales-performance-agg
Full Description

[shopper] Product Sales Performance Returns time-series sales performance data for a specific product (ASIN) on Amazon.

Parameters (2 required, 3 optional)
Required
asinstring

Amazon Standard Identification Number. Must be exactly 10 characters (uppercase alphanumeric only). Format: 10 uppercase letters and/or numbers (e.g., 'B0DLFVP6YM'). ASINs are Amazon-specific and cannot be used across different Amazon domains **Constraints:** ASIN must be exactly 10 characters (uppercase alphanumeric)

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain **Constraints:** domain and ASIN are required

Optional
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'weekly', 'monthly'

Options:monthlyweekly
Default: null

Get-products-top-keywords

get-products-top-keywords
Full Description

[shopper] Product Top Keywords Returns list of top on-site search keywords for a product (ASIN), ranked by selected metrics.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (2 required, 5 optional)
Required
asinstring

Amazon Standard Identification Number. Must be exactly 10 characters (uppercase alphanumeric only). Format: 10 uppercase letters and/or numbers (e.g., 'B0DLFVP6YM'). ASINs are Amazon-specific and cannot be used across different Amazon domains

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'monthly', 'weekly' granularity (for date resolution)

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-products-top-keywords-agg

get-products-top-keywords-agg
Full Description

[shopper] Product Top Keywords Returns list of top on-site search keywords for a product (ASIN), ranked by selected metrics.

General Constraints:

{
  "pagination": "supports pagination (limit, offset, sort, asc)",
  "default_date_range": "default date range: last 28 days"
}
Parameters (2 required, 5 optional)
Required
asinstring

Amazon Standard Identification Number. Must be exactly 10 characters (uppercase alphanumeric only). Format: 10 uppercase letters and/or numbers (e.g., 'B0DLFVP6YM'). ASINs are Amazon-specific and cannot be used across different Amazon domains

domainstring

Amazon domain. Supported domains: amazon.com, amazon.co.uk, amazon.it, amazon.fr, amazon.de, amazon.ca. All category IDs, brands, and ASINs are domain-specific and must match the selected domain

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format. For weekly granularity with MTD=true, automatically set to the latest available Saturday. For weekly granularity with MTD=false, automatically adjusted to the last Saturday of the specified month.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports 'monthly', 'weekly' granularity (for date resolution)

Options:monthlyweekly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-retail-cross-analysis-brands-search

get-retail-cross-analysis-brands-search
Full Description

[criq] Search brands for a CRIQ custom category Returns brands matching a search term for a custom category, with optional domain filters.

Parameters (1 required, 5 optional)
Required
category_idstring

Custom category UUID from the describe endpoint's custom_categories list (required on analytics endpoints). **Constraints:** Must be a valid custom category UUID.

Optional
ascboolean

Orders the results by ascending or descending

Default: null
domainsarray

Optional comma-separated retailer domains (without 'www.') to restrict results. Use categories/domains or describe category filters to discover valid domains.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-retail-cross-analysis-category-domains

get-retail-cross-analysis-category-domains
Full Description

[criq] List retailer domains for a CRIQ custom category Returns retailer domains included in a Cross Retail IQ (CRIQ) custom category. Requires category_id (UUID from describe). Supports only weekly granularity. Optionally filter by market_code (two-letter code from describe markets); omit to return all markets.

Parameters (1 required, 4 optional)
Required
category_idstring

Custom category UUID from the describe endpoint's custom_categories list (required on analytics endpoints). **Constraints:** Must be a valid custom category UUID.

Optional
ascboolean

Orders the results by ascending or descending

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** Supports only weekly granularity.

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-retail-cross-analysis-describe

get-retail-cross-analysis-describe
Full Description

[criq] Get Cross Retail IQ (CRIQ) data availability, custom categories, and supported markets Returns Cross Retail IQ (CRIQ) discovery metadata and lists used by other endpoints. Call this before other CRIQ endpoints. The response includes start_date and fresh_data for the supported weekly data window; custom_categories with full category definitions (identifiers, names, filter criteria such as departments, categories, tags, brands, and domains), optionally filtered by criq_category_id, name_contains, and name_not_contains; and markets with available retailer market codes.

Parameters (0 required, 3 optional)
Optional
ascboolean

Orders the results by ascending or descending

Default: null
criq_category_idstring

Optional custom category UUID (criq_category_id); when set, only that category is returned in custom_categories if it is available to the caller.

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-retail-cross-analysis-domain-coverage

get-retail-cross-analysis-domain-coverage
Full Description

[criq] Check CRIQ catalog coverage for retailer domains Returns whether each requested retailer domain exists in the Cross Retail IQ (CRIQ) product catalog. Each data row lists a domain hostname and whether it is covered (true = in catalog, false = not in catalog).

Parameters (1 required)
Required
domainsarray

Required comma-separated retailer domains (1–50 unique hostnames, without 'www.'). **Constraints:** Required comma-separated retailer domains (1–50 unique hostnames, without 'www.').

Get-retail-cross-oss-categories-top-keywords

get-retail-cross-oss-categories-top-keywords
Full Description

[criq] List top on-site search keywords for a CRIQ custom category Returns top keywords for a custom category over a weekly date range with optional brand and keyword filters.

Parameters (3 required, 10 optional)
Required
category_idstring

Custom category UUID from the describe endpoint's custom_categories list (required on analytics endpoints). **Constraints:** Must be a valid custom category UUID.

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Required. YYYY-MM resolves to month-end and is clamped to latest available data when needed.

start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Required. No default date window is applied when omitted.

Optional
ascboolean

Orders the results by ascending or descending

Default: null
brandsarray

Optional comma-separated brand names to restrict results (case-sensitive matching per gateway).

Default: null
domainsarray

Optional comma-separated retailer domains (without 'www.') to restrict results. Use categories/domains or describe category filters to discover valid domains.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** Supports only weekly granularity.

Default: null
keyword_containsstring

Filter keywords containing this text.

Default: null
keyword_not_containsstring

Filter keywords not containing this text.

Default: null
keyword_total_clicks_maxnumber

Maximum keyword total clicks. **Constraints:** Must be greater than or equal to 0.

Default: null
keyword_total_clicks_minnumber

Minimum keyword total clicks. **Constraints:** Must be greater than or equal to 0; when max is provided, min must be less than or equal to max.

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-retail-cross-oss-categories-top-keywords-agg

get-retail-cross-oss-categories-top-keywords-agg
Full Description

[criq] List top on-site search keywords for a CRIQ custom category (aggregated) Returns top keywords aggregated across domains and/or time for a custom category.

Parameters (3 required, 12 optional)
Required
category_idstring

Custom category UUID from the describe endpoint's custom_categories list (required on analytics endpoints). **Constraints:** Must be a valid custom category UUID.

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Required. YYYY-MM resolves to month-end and is clamped to latest available data when needed.

start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Required. No default date window is applied when omitted.

Optional
aggregate_across_domainsboolean

When true, aggregates results across domains. Defaults to false on aggregated endpoints. **Constraints:** Defaults to false when omitted.

Default: null
aggregate_across_timeboolean

When true, aggregates results across time; date is omitted from rows. Defaults to true on aggregated endpoints. **Constraints:** Defaults to true when omitted.

Default: null
ascboolean

Orders the results by ascending or descending

Default: null
brandsarray

Optional comma-separated brand names to restrict results (case-sensitive matching per gateway).

Default: null
domainsarray

Optional comma-separated retailer domains (without 'www.') to restrict results. Use categories/domains or describe category filters to discover valid domains.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** Supports only weekly granularity.

Default: null
keyword_containsstring

Filter keywords containing this text.

Default: null
keyword_not_containsstring

Filter keywords not containing this text.

Default: null
keyword_total_clicks_maxnumber

Maximum keyword total clicks. **Constraints:** Must be greater than or equal to 0.

Default: null
keyword_total_clicks_minnumber

Minimum keyword total clicks. **Constraints:** Must be greater than or equal to 0; when max is provided, min must be less than or equal to max.

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-retail-cross-performance-categories-performance

get-retail-cross-performance-categories-performance
Full Description

[criq] Brand/Category performance for a CRIQ custom category Returns weekly brand or category performance metrics by domain for a custom category. When brand_name is provided, returns brand vs category metrics; when omitted, returns category performance only.

Parameters (3 required, 6 optional)
Required
category_idstring

Custom category UUID from the describe endpoint's custom_categories list (required on analytics endpoints). **Constraints:** Must be a valid custom category UUID.

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Required. YYYY-MM resolves to month-end and is clamped to latest available data when needed.

start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Required. No default date window is applied when omitted.

Optional
ascboolean

Orders the results by ascending or descending

Default: null
brand_namestring

Optional brand name. When provided, returns brand vs category metrics; when omitted, returns category performance only. **Constraints:** Optional. When provided, returns brand vs category metrics.

Default: null
domainsarray

Optional comma-separated retailer domains (without 'www.') to restrict results. Use categories/domains or describe category filters to discover valid domains.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** Supports only weekly granularity.

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-retail-cross-performance-categories-performance-agg

get-retail-cross-performance-categories-performance-agg
Full Description

[criq] Brand/Category performance for a CRIQ custom category (aggregated) Returns brand or category performance aggregated across domains and/or time. When brand_name is provided, returns brand vs category metrics; when omitted, returns category performance only.

Parameters (3 required, 8 optional)
Required
category_idstring

Custom category UUID from the describe endpoint's custom_categories list (required on analytics endpoints). **Constraints:** Must be a valid custom category UUID.

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Required. YYYY-MM resolves to month-end and is clamped to latest available data when needed.

start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Required. No default date window is applied when omitted.

Optional
aggregate_across_domainsboolean

When true, aggregates results across domains. Defaults to false on aggregated endpoints. **Constraints:** Defaults to false when omitted.

Default: null
aggregate_across_timeboolean

When true, aggregates results across time; date is omitted from rows. Defaults to true on aggregated endpoints. **Constraints:** Defaults to true when omitted.

Default: null
ascboolean

Orders the results by ascending or descending

Default: null
brand_namestring

Optional brand name. When provided, returns brand vs category metrics; when omitted, returns category performance only. **Constraints:** Optional. When provided, returns brand vs category metrics.

Default: null
domainsarray

Optional comma-separated retailer domains (without 'www.') to restrict results. Use categories/domains or describe category filters to discover valid domains.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** Supports only weekly granularity.

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-retail-cross-performance-categories-top-brands

get-retail-cross-performance-categories-top-brands
Full Description

[criq] List top brands for a CRIQ custom category Returns top brands for a custom category over a weekly date range, with optional domain filters and metric selection.

Parameters (3 required, 5 optional)
Required
category_idstring

Custom category UUID from the describe endpoint's custom_categories list (required on analytics endpoints). **Constraints:** Must be a valid custom category UUID.

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Required. YYYY-MM resolves to month-end and is clamped to latest available data when needed.

start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Required. No default date window is applied when omitted.

Optional
ascboolean

Orders the results by ascending or descending

Default: null
domainsarray

Optional comma-separated retailer domains (without 'www.') to restrict results. Use categories/domains or describe category filters to discover valid domains.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** Supports only weekly granularity.

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-retail-cross-performance-categories-top-brands-agg

get-retail-cross-performance-categories-top-brands-agg
Full Description

[criq] List top brands for a CRIQ custom category (aggregated) Returns top brands aggregated across domains and/or time for a custom category.

Parameters (3 required, 7 optional)
Required
category_idstring

Custom category UUID from the describe endpoint's custom_categories list (required on analytics endpoints). **Constraints:** Must be a valid custom category UUID.

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Required. YYYY-MM resolves to month-end and is clamped to latest available data when needed.

start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Required. No default date window is applied when omitted.

Optional
aggregate_across_domainsboolean

When true, aggregates results across domains. Defaults to false on aggregated endpoints. **Constraints:** Defaults to false when omitted.

Default: null
aggregate_across_timeboolean

When true, aggregates results across time; date is omitted from rows. Defaults to true on aggregated endpoints. **Constraints:** Defaults to true when omitted.

Default: null
ascboolean

Orders the results by ascending or descending

Default: null
domainsarray

Optional comma-separated retailer domains (without 'www.') to restrict results. Use categories/domains or describe category filters to discover valid domains.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** Supports only weekly granularity.

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-retail-cross-performance-categories-top-products

get-retail-cross-performance-categories-top-products
Full Description

[criq] List top products for a CRIQ custom category Returns top products for a CRIQ custom category over start_date–end_date with weekly granularity. Each row is one product × retailer domain × week (date bucket). Supports filters (domains, brands, title, views range), sorting, pagination, and optional metrics projection. Call describe first for category_id and supported markets.

Parameters (3 required, 6 optional)
Required
category_idstring

Custom category UUID from the describe endpoint's custom_categories list (required on analytics endpoints). **Constraints:** Must be a valid custom category UUID.

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Required. YYYY-MM resolves to month-end and is clamped to latest available data when needed.

start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Required. No default date window is applied when omitted.

Optional
ascboolean

Orders the results by ascending or descending

Default: null
brandsarray

Optional comma-separated brand names to restrict results (case-sensitive matching per gateway).

Default: null
domainsarray

Optional comma-separated retailer domains (without 'www.') to restrict results. Use categories/domains or describe category filters to discover valid domains.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** Supports only weekly granularity.

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-retail-cross-performance-categories-top-products-agg

get-retail-cross-performance-categories-top-products-agg
Full Description

[criq] List top products for a CRIQ custom category (aggregated) Returns top products for a CRIQ custom category aggregated across the full start_date–end_date window (no per-week date buckets). Uses the same category_id, filters, sorting, pagination, and metrics as top products. Supports only weekly granularity.

General Constraints:

{
  "aggregate_across_time": "Defaults to true when omitted.",
  "aggregate_across_domains": "Defaults to false when omitted."
}
Parameters (3 required, 6 optional)
Required
category_idstring

Custom category UUID from the describe endpoint's custom_categories list (required on analytics endpoints). **Constraints:** Must be a valid custom category UUID.

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Required. YYYY-MM resolves to month-end and is clamped to latest available data when needed.

start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** Required. No default date window is applied when omitted.

Optional
ascboolean

Orders the results by ascending or descending

Default: null
brandsarray

Optional comma-separated brand names to restrict results (case-sensitive matching per gateway).

Default: null
domainsarray

Optional comma-separated retailer domains (without 'www.') to restrict results. Use categories/domains or describe category filters to discover valid domains.

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** Supports only weekly granularity.

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-sales-signals-ad-network

get-sales-signals-ad-network
Full Description

[web] Get Ad Network Signals Retrieve ad network signal events for a domain. Detects when a domain starts or stops working with an advertising network based on a 12-month rolling window of paid referral data. Data is monthly, released ~6th of the following month. Without date parameters, returns the latest available snapshot.

Parameters (0 required, 5 optional)
Optional
company_domainstring

Company domain to retrieve signals for (e.g., `shopify.com`). Provide either `company_domain` or `company_name`. If both are provided, `company_domain` is used. **Constraints:** optional; provide either 'company_domain' or 'company_name'. If both are given, 'company_domain' is used

Default: null
company_namestring

Company name to retrieve signals for (e.g., `Shopify`). Resolved to a domain server-side. Provide either `company_domain` or `company_name`. If both are provided, `company_domain` is used. **Constraints:** optional; provide either 'company_domain' or 'company_name'. If both are given, 'company_domain' is used

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** optional, format YYYY-MM. Defaults to last available snapshot month

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity, latest snapshot only (point-in-time)

Default: null

Get-sales-signals-ecommerce

get-sales-signals-ecommerce
Full Description

[web] Get Ecommerce Signals Retrieve ecommerce signal events for a domain. Detects online revenue and transaction volume changes (month-over-month, quarter-over-quarter, year-over-year) and bucket transitions. Data is monthly, released ~6th of the following month. Without date parameters, returns the latest available snapshot.

Parameters (0 required, 5 optional)
Optional
company_domainstring

Company domain to retrieve signals for (e.g., `shopify.com`). Provide either `company_domain` or `company_name`. If both are provided, `company_domain` is used. **Constraints:** optional; provide either 'company_domain' or 'company_name'. If both are given, 'company_domain' is used

Default: null
company_namestring

Company name to retrieve signals for (e.g., `Shopify`). Resolved to a domain server-side. Provide either `company_domain` or `company_name`. If both are provided, `company_domain` is used. **Constraints:** optional; provide either 'company_domain' or 'company_name'. If both are given, 'company_domain' is used

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** optional, format YYYY-MM. Defaults to last available snapshot month

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity, latest snapshot only (point-in-time)

Default: null

Get-sales-signals-intent

get-sales-signals-intent
Full Description

[web] Get Intent Signals Retrieve intent signal events for a domain. Detects topic interest based on a rolling composite score (0-100) with week-over-week delta. Only signals with composite_score >= 60 are surfaced. Data is weekly. Without date parameters, returns the latest 14 days of data.

Parameters (0 required, 5 optional)
Optional
company_domainstring

Company domain to retrieve signals for (e.g., `shopify.com`). Provide either `company_domain` or `company_name`. If both are provided, `company_domain` is used. **Constraints:** optional; provide either 'company_domain' or 'company_name'. If both are given, 'company_domain' is used

Default: null
company_namestring

Company name to retrieve signals for (e.g., `Shopify`). Resolved to a domain server-side. Provide either `company_domain` or `company_name`. If both are provided, `company_domain` is used. **Constraints:** optional; provide either 'company_domain' or 'company_name'. If both are given, 'company_domain' is used

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** optional, format YYYY-MM-DD. Defaults to last available intent update day

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only weekly granularity, latest snapshot only (point-in-time)

Default: null

Get-sales-signals-news

get-sales-signals-news
Full Description

[web] Get News Signals Retrieve company news signal events for a domain. Detects categorized news events such as funding rounds, M&A activity, leadership changes, partnerships, and more. Data is daily with multiple recency windows (Day, Week, TwoWeeks, ThreeWeeks, Month). Without date parameters, returns today's latest data.

Parameters (0 required, 5 optional)
Optional
company_domainstring

Company domain to retrieve signals for (e.g., `shopify.com`). Provide either `company_domain` or `company_name`. If both are provided, `company_domain` is used. **Constraints:** optional; provide either 'company_domain' or 'company_name'. If both are given, 'company_domain' is used

Default: null
company_namestring

Company name to retrieve signals for (e.g., `Shopify`). Resolved to a domain server-side. Provide either `company_domain` or `company_name`. If both are provided, `company_domain` is used. **Constraints:** optional; provide either 'company_domain' or 'company_name'. If both are given, 'company_domain' is used

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** optional, format YYYY-MM-DD. Defaults to today

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only daily granularity, up to 730 days

Default: null

Get-sales-signals-technology

get-sales-signals-technology
Full Description

[web] Get Technology Signals Retrieve technology signal events for a domain. Detects technology additions, removals, and upcoming license renewals. Data is daily with multiple lookback windows (Day, Week, TwoWeeks, ThreeWeeks, Month). ThreeMonths/SixMonths windows are forward-looking renewal predictions. Without date parameters, returns today's latest data.

Parameters (0 required, 5 optional)
Optional
company_domainstring

Company domain to retrieve signals for (e.g., `shopify.com`). Provide either `company_domain` or `company_name`. If both are provided, `company_domain` is used. **Constraints:** optional; provide either 'company_domain' or 'company_name'. If both are given, 'company_domain' is used

Default: null
company_namestring

Company name to retrieve signals for (e.g., `Shopify`). Resolved to a domain server-side. Provide either `company_domain` or `company_name`. If both are provided, `company_domain` is used. **Constraints:** optional; provide either 'company_domain' or 'company_name'. If both are given, 'company_domain' is used

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** optional, format YYYY-MM-DD. Defaults to today

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only daily granularity, up to 730 days

Default: null

Get-sales-signals-traffic

get-sales-signals-traffic
Full Description

[web] Get Traffic Signals Retrieve traffic signal events for a domain. Detects significant traffic changes (month-over-month, quarter-over-quarter, year-over-year) and new market entries based on configured traffic signal thresholds. Data is monthly, released ~6th of the following month. Without date parameters, returns the latest available snapshot.

Parameters (0 required, 5 optional)
Optional
company_domainstring

Company domain to retrieve signals for (e.g., `shopify.com`). Provide either `company_domain` or `company_name`. If both are provided, `company_domain` is used. **Constraints:** optional; provide either 'company_domain' or 'company_name'. If both are given, 'company_domain' is used

Default: null
company_namestring

Company name to retrieve signals for (e.g., `Shopify`). Resolved to a domain server-side. Provide either `company_domain` or `company_name`. If both are provided, `company_domain` is used. **Constraints:** optional; provide either 'company_domain' or 'company_name'. If both are given, 'company_domain' is used

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago **Constraints:** optional, format YYYY-MM. Defaults to last available snapshot month

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity, latest snapshot only (point-in-time)

Default: null

Get-segments-traffic-and-engagement

get-segments-traffic-and-engagement
Full Description

[web] Segment Traffic and Engagement Returns the traffic and engagement metrics of a segment of a website on desktop devices. Includes visits, bounce rate, pages per visit, visit duration, pageviews, traffic share, unique visitors.

General Constraints:

{
  "unique_visitors": "unique_visitors metric can only be requested for monthly granularity"
}
Parameters (1 required, 4 optional)
Required
segmentstring

Segment ID to analyze

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Options:dailyweeklymonthly
Default: null

Get-segments-traffic-sources

get-segments-traffic-sources
Full Description

[web] Segment Marketing Channels Returns visits per traffic channel for a website segment.

General Constraints:

{
  "bounce_rate": "bounce_rate metric can only be requested for desktop web_source",
  "page_views": "page_views metric can only be requested for desktop web_source",
  "average_visit_duration": "visit_duration metric can only be requested for desktop web_source",
  "pages_per_visit": "pages_per_visit metric can only be requested for desktop web_source"
}
Parameters (1 required, 4 optional)
Required
segmentstring

Segment ID to analyze

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** desktop web_source supports weekly and monthly granularity; total web_source supports monthly only

Default: null

Get-traffic-channels-share

get-traffic-channels-share
Full Description

[web] Traffic Channels Share Returns website traffic broken down by marketing channel (e.g. Organic Search, Paid Search, Direct, Referrals) with visit counts for the selected time frame. Supports daily, weekly, and monthly granularity for all web sources.

Parameters (1 required, 6 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Options:dailyweeklymonthly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-traffic-referrals-incoming

get-traffic-referrals-incoming
Full Description

[web] Incoming Traffic Referrals Returns key outgoing and incoming referral traffic data for comprehensive website traffic insights.

General Constraints:

{
  "change": "change data is not available for daily granularity",
  "referral_type": "publishers, advertisers and social referral types are only supported for desktop web source"
}
Parameters (1 required, 6 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity, or daily granularity for the last 28 days only

Options:dailyweeklymonthly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-traffic-referrals-outgoing

get-traffic-referrals-outgoing
Full Description

[web] Outgoing Traffic Referrals Returns key outgoing and incoming referral traffic data for comprehensive website traffic insights.

General Constraints:

{
  "change": "change data is not available for daily granularity",
  "referral_type": "publishers, advertisers and social referral types are only supported for desktop web source"
}
Parameters (1 required, 6 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity, or daily granularity for the last 28 days only

Options:dailyweeklymonthly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-user-segments-describe

get-user-segments-describe
Full Description

[web] Get list of user segments.

Parameters (0 required, 2 optional)
Optional
charsstring
Default: null
lengthinteger
Default: null

Get-website-analysis-ad-networks-agg

get-website-analysis-ad-networks-agg
Full Description

[web] Ad Networks Returns the top ad networks sending traffic to (incoming) or receiving traffic from (outgoing) a domain, along with traffic share per ad network for the selected time period.

General Constraints:

{
  "change": "change data is not available for daily granularity and for outgoing ad networks type"
}
Parameters (1 required, 7 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ad_network_typestring

Type of ad network: 'incoming' (default) for traffic sources, 'outgoing' for traffic destinations

Options:incomingoutgoing
Default: null
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-website-analysis-display-advertisers-agg

get-website-analysis-display-advertisers-agg
Full Description

[web] Top advertisers placing display ads on a website Returns the top advertisers placing display ads on a publisher website, with visits share and period-over-period change per advertiser.

Parameters (1 required, 6 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports monthly granularity, or daily granularity for the last 28 days (window) only

Options:monthlydaily
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-website-analysis-display-network-publisher-pairs-agg

get-website-analysis-display-network-publisher-pairs-agg
Full Description

[web] Top ad network × publisher pairs for an advertiser's display ad traffic Returns a cross-tab of ad networks × publishers pairs carrying an advertiser's display ads, with share of traffic and period-over-period change per (ad network, publisher) pair.

Parameters (1 required, 7 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ad_networkstring

Optional filter: return only pairs from this ad network (open universe — any string value accepted; unknown values return empty results) **Constraints:** optional; exact-match filter; unknown values return empty results

Default: null
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports monthly granularity, or daily granularity for the last 28 days (window) only

Options:monthlydaily
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-website-analysis-display-networks-agg

get-website-analysis-display-networks-agg
Full Description

[web] Ad Networks Returns the top ad networks sending traffic to (incoming) or receiving traffic from (outgoing) a domain, along with traffic share per ad network for the selected time period. Use data_version=VERSION_5.0 (default) or data_version=VERSION_6.0.

Parameters (1 required, 8 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ad_network_typestring

Type of ad network: 'incoming' (default) for traffic sources, 'outgoing' for traffic destinations **Constraints:** 'incoming' (default) or 'outgoing'

Options:incomingoutgoing
Default: null
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
data_versionstring

Optional data version name for accessing alternative data versions **Constraints:** Always set to 'VERSION_6.0' (current); 'VERSION_5.0' is deprecated legacy data, retained only for historical comparison

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** monthly (up to 39 months), or daily for the last 28 days only; daily must align to that fixed window; omit both dates to default to the last 28 days

Options:dailymonthly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-website-analysis-display-publishers-agg

get-website-analysis-display-publishers-agg
Full Description

[web] Top publishers serving display ads for an advertiser Returns the top publishers carrying an advertiser's display ads, with visits share and period-over-period change per publisher for the selected period.

Parameters (1 required, 6 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports monthly granularity, or daily granularity for the last 28 days (window) only

Options:monthlydaily
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-website-analysis-display-publishers-by-network-agg

get-website-analysis-display-publishers-by-network-agg
Full Description

[web] Publishers serving an advertiser's display ads, broken down by ad network Returns publishers carrying an advertiser's display ads broken down by ad network, with visits share and period-over-period change per publisher × ad-network pair.

Parameters (1 required, 7 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ad_networkstring

Restrict results to a single ad network (open-universe, exact match) **Constraints:** optional; restrict to a single ad network (exact match)

Default: null
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports monthly granularity, or daily granularity for the last 28 days (window) only

Options:monthlydaily
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-website-analysis-display-publishers-in-network-agg

get-website-analysis-display-publishers-in-network-agg
Full Description

[web] Top publishers carrying an advertiser's display ads within a specific ad network Returns the top publishers carrying an advertiser's display ads within a specific ad network, with visits share and period-over-period change per publisher.

Parameters (2 required, 6 optional)
Required
ad_networkstring

Name of the ad network to filter publishers by. **Constraints:** required; ad network name (exact match)

domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports monthly granularity, or daily granularity for the last 28 days (window) only

Options:monthlydaily
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-website-analysis-keywords-agg

get-website-analysis-keywords-agg
Full Description

[web] Website Keywords Returns the keywords driving search clicks to a specified domain along with click volume, traffic share, and position metrics for the selected time period.

Parameters (1 required, 8 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
branded_typestring

Branded keyword type - 'all', 'branded', or 'non_branded'

Options:allbrandednon_branded
Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity for last 3 months only

Default: null
keywords_filter_rulesarray

Filter rules for keywords as a URL-encoded JSON array. Each rule specifies whether to include/exclude keywords and how to match them (exact or phrase). Structure: {[{"type": "include | exclude", "match_type": "exact | phrase", "keywords": ["keyword1", "keyword2"]}]}. Example: {[{"type": "exclude", "match_type": "phrase", "keywords": ["brand name", "company"]}, {"type": "include", "match_type": "exact", "keywords": ["marketing"]}]}

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-website-analysis-search-spend

get-website-analysis-search-spend
Full Description

[web] PPC Spend Returns an estimate of a website's spend on paid search (PPC) terms over the selected period, broken down by month in the requested currency. Use data_version=VERSION_5.0 (default) or data_version=VERSION_6.0.

Parameters (1 required, 7 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
currencystring

Currency for PPC spend: 'USD', 'EUR', 'AUD', 'GBP' or 'JPY'. Default is 'USD' **Constraints:** usd (default), eur, gbp, jpy, or aud; one currency per response row

Options:audeurgbpjpyusd
Default: null
data_versionstring

Optional data version name for accessing alternative data versions **Constraints:** Always set to 'VERSION_6.0' (current); 'VERSION_5.0' is deprecated legacy data, retained only for historical comparison

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** monthly only; maximum date span is 39 months

Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-website-analysis-social-traffic-sources-agg

get-website-analysis-social-traffic-sources-agg
Full Description

[web] Top social networks driving traffic to a website Returns the top social networks driving traffic to a website, with traffic share and period-over-period change per network.

Parameters (1 required, 7 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports monthly granularity, or daily granularity for the last 28 days (window) only

Options:monthlydaily
Default: null
limitinteger

Sets how many results to return.

Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-website-analysis-traffic-channels

get-website-analysis-traffic-channels
Full Description

[web] Traffic Channels by Marketing Channel Returns website traffic broken down by marketing channel (e.g. Organic Search, Paid Search, Direct, Referrals) with visit counts for the selected time frame. Supports daily, weekly, and monthly granularity for all web sources.

Parameters (1 required, 5 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Options:dailyweeklymonthly
Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-website-analysis-traffic-channels-share

get-website-analysis-traffic-channels-share
Full Description

[web] Traffic Channels Share Returns website traffic broken down by marketing channel (e.g. Organic Search, Paid Search, Direct, Referrals) with visit counts for the selected time frame. Supports daily, weekly, and monthly granularity for all web sources.

Parameters (1 required, 7 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Options:dailyweeklymonthly
Default: null
limitinteger

Sets how many results to return.

Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-website-analysis-traffic-referrals-aggregated

get-website-analysis-traffic-referrals-aggregated
Full Description

[web] Aggregated Traffic Referrals Returns aggregated referral traffic data with per-domain visits, share, and change metrics.

General Constraints:

{
  "change": "change data is not available for daily granularity"
}
Parameters (1 required, 7 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
limitinteger

Sets how many results to return.

Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-website-analysis-traffic-referrals-incoming

get-website-analysis-traffic-referrals-incoming
Full Description

[web] Incoming Traffic Referrals Returns key outgoing and incoming referral traffic data for comprehensive website traffic insights.

General Constraints:

{
  "change": "change data is not available for daily granularity",
  "referral_type": "publishers, advertisers and social referral types are only supported for desktop web source"
}
Parameters (1 required, 7 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
limitinteger

Sets how many results to return.

Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-website-analysis-traffic-referrals-outgoing

get-website-analysis-traffic-referrals-outgoing
Full Description

[web] Outgoing Traffic Referrals Returns key outgoing and incoming referral traffic data for comprehensive website traffic insights.

General Constraints:

{
  "change": "change data is not available for daily granularity",
  "referral_type": "publishers, advertisers and social referral types are only supported for desktop web source"
}
Parameters (1 required, 6 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-website-content-subdomains-agg

get-website-content-subdomains-agg
Full Description

[web] Subdomains Returns a list of subdomains and traffic share per subdomain.

Parameters (1 required, 6 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-website-content-technologies-agg

get-website-content-technologies-agg
Full Description

[web] Website Technologies Returns a list of the web plugins or integrations currently installed on a website.

Parameters (1 required, 6 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
categorystring

Main category of the technology

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** Returns current technology data (no time series) for the last month; supports only monthly granularity

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-websites-audience-interests-agg

get-websites-audience-interests-agg
Full Description

[web] Audience Interests Returns insights into a website's audience interests and affinity.

Parameters (1 required, 6 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-websites-audience-overlap-agg

get-websites-audience-overlap-agg
Full Description

[web] Audience Overlap Returns the shared unique visitors, the average unique visitors for each of these domains and the total unique visitors for all of them.

Parameters (1 required, 4 optional)
Required
domainsstring

Comma-separated list of unique website domains (without 'www.') **Constraints:** must include between 2 and 5 unique domains

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity

Default: null

Get-websites-conversion-rates

get-websites-conversion-rates
Full Description

[web] Conversion Rates Over Time Returns conversion rates per month for the specified domains.

Parameters (1 required, 4 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity

Default: null

Get-websites-conversion-rates-agg

get-websites-conversion-rates-agg
Full Description

[web] Conversion Rates Aggregated Returns aggregated conversion rates for the specified domains.

Parameters (1 required, 4 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity

Default: null

Get-websites-deduplicated-audience

get-websites-deduplicated-audience
Full Description

[web] Deduplicated Audience Returns the number of individuals visiting a domain deduplicated across devices.

Parameters (1 required, 4 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity

Default: null

Get-websites-demographics

get-websites-demographics
Full Description

[web] Demographics Over Time Returns a breakdown of the domain's traffic by gender and age over time.

Parameters (1 required, 4 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity

Default: null

Get-websites-demographics-agg

get-websites-demographics-agg
Full Description

[web] Demographics Returns a breakdown of the domain's traffic by gender and age.

Parameters (1 required, 4 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity

Default: null

Get-websites-geography-agg

get-websites-geography-agg
Full Description

[web] Top Geographies Returns the total traffic share, visits, pages per visit, average time, bounce rate and rank broken down by country, between the selected dates (min. 1 month).

Parameters (1 required, 6 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
limitinteger

Sets how many results to return.

Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-websites-keywords-competitors-agg

get-websites-keywords-competitors-agg
Full Description

[web] Keyword Competitors Returns competitor domains that rank for similar keywords as the target website, with competitiveness scores and shared keyword metrics.

Parameters (1 required, 7 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity for periods of 1, 2, or 3 months

Default: null
limitinteger

Sets how many results to return.

Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-websites-landing-pages-agg

get-websites-landing-pages-agg
Full Description

[web] Landing Pages Returns a list of pages receiving incoming traffic from organic search traffic and traffic share per landing page.

Parameters (1 required, 6 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity for last month, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
limitinteger

Sets how many results to return.

Default: null

Get-websites-ppc-spend

get-websites-ppc-spend
Full Description

[web] PPC Spend Returns an estimate of a website’s spend on PPC search terms over an analyzed period.

Parameters (1 required, 6 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
currencystring

Currency for PPC spend: 'USD', 'EUR', 'AUD', 'GBP' or 'JPY'. Default is 'USD'

Options:audeurgbpjpyusd
Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity

Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-websites-referrals-agg

get-websites-referrals-agg
Full Description

[web] Referrals Returns key outgoing and incoming referral traffic data for comprehensive website traffic insights.

General Constraints:

{
  "change": "change data is not available for daily granularity"
}
Parameters (1 required, 7 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
limitinteger

Sets how many results to return.

Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-websites-serp-players

get-websites-serp-players
Full Description

[web] SERP players

  • Clicks over time

Returns how clicks for top-ranking domains on a keyword evolve over time, showing competitive landscape changes across time periods.

Parameters (1 required, 7 optional)
Required
keywordstring

A single keyword or name of a keyword group to analyze

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity for the last 13 months, or daily granularity for the last 397 days only

Options:dailymonthly
Default: null
is_keyword_groupboolean

A boolean flag to specify if a keyword group is provided or a single keyword. Default is 'false'

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-websites-serp-players-agg

get-websites-serp-players-agg
Full Description

[web] SERP players Returns the top-ranking domains for a keyword with their total clicks, traffic share, SERP features presence, and best-ranking URLs over the specified period.

Parameters (1 required, 7 optional)
Required
keywordstring

A single keyword or name of a keyword group to analyze

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity for the last 3 months, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
is_keyword_groupboolean

A boolean flag to specify if a keyword group is provided or a single keyword. Default is 'false'

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-websites-similar-sites-agg

get-websites-similar-sites-agg
Full Description

[web] SimilarSites Returns top websites similar to a domain with detailed similarity scores.

Parameters (1 required, 6 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
categorystring

Website industry category identifier

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity for the last 3 months

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-websites-top-sites-by-category-agg

get-websites-top-sites-by-category-agg
Full Description

[web] Top Sites Returns last month's top websites in a given category.

Parameters (1 required, 7 optional)
Required
categorystring

Website industry category identifier

Optional
ascboolean

Orders the results by ascending or descending

Default: null
channelstring

Type of traffic source the visit came from **Constraints:** Data is limited to 1 last month for specific channel and up to 3 months for the 'total' channel

Options:totalsearchorganic_searchpaid_searchsocialdisplay_adsreferraldirectmail
Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** Returns current top sites data (no time series) for up to the last 3 months; supports only monthly granularity

Default: null
limitinteger

Sets how many results to return.

Default: null

Get-websites-traffic-and-engagement

get-websites-traffic-and-engagement
Full Description

[web] Traffic & Engagement Returns a website traffic and user engagement across platforms for performance insights.

General Constraints:

{
  "unique_visitors": "unique_visitors metric can only be requested for daily and monthly granularity",
  "new_users": "new_users metric can only be requested for monthly granularity and total web_source",
  "returning_users": "returning_users metric can only be requested for monthly granularity and total web_source"
}
Parameters (1 required, 5 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Options:dailyweeklymonthly
Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-websites-traffic-by-demographics-agg

get-websites-traffic-by-demographics-agg
Full Description

[web] Demographic groups Returns a breakdown of the domain's traffic by gender and age groups.

General Constraints:

{
  "age_bucket": "Must specify at least one age_bucket",
  "male_data": "At least one of male_data or female_data must be 'true'",
  "female_data": "At least one of male_data or female_data must be 'true'"
}
Parameters (1 required, 6 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
age_bucketsarray

Comma-separated list of ages representing age groups: 18, 25, 35, 45, 55, 65

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
genderstring

Gender filter: 'male', 'female', or 'all'. Default is 'all'

Options:malefemaleall
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity

Default: null

Get-websites-traffic-channels

get-websites-traffic-channels
Full Description

[web] Traffic Channels by Marketing Channel Returns website traffic broken down by marketing channel (e.g. Organic Search, Paid Search, Direct, Referrals) with visit counts for the selected time frame. Supports daily, weekly, and monthly granularity for all web sources.

Parameters (1 required, 5 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Options:dailyweeklymonthly
Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-websites-traffic-referrals-agg

get-websites-traffic-referrals-agg
Full Description

[web] Aggregated Traffic Referrals Returns key outgoing and incoming referral traffic data for comprehensive website traffic insights.

General Constraints:

{
  "change": "change data is not available for daily granularity"
}
Parameters (1 required, 7 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
ascboolean

Orders the results by ascending or descending

Default: null
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null
limitinteger

Sets how many results to return.

Default: null
main_domain_onlyboolean

True' will include only the main domain, 'false' will include subdomains. Default is 'false'

Default: null

Get-websites-website-rank

get-websites-website-rank
Full Description

[web] Website Ranking Returns the websites position in global rank within a specific category.

Parameters (1 required, 4 optional)
Required
domainstring

Enter website of interest, without 'www.' or brackets {}

Optional
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values **Constraints:** supports only monthly granularity, or daily granularity for the last 28 days only

Options:dailymonthly
Default: null

Post-contact-enrichment-contacts

post-contact-enrichment-contacts
Full Description

[contacts] Sales Contacts Enrichment Enrich contact information with detailed data including email addresses, phone numbers, and professional details.

General Constraints:

{
  "constraints": "must provide one of: contact_id alone | email alone | hashed_email alone | linkedin_url alone | (first_name AND last_name AND (company_name OR domain)) | (full_name AND (company_name OR domain))"
}
Parameters (0 required, 12 optional)
Optional
company_namestring

Name of the company associated with the contact **Constraints:** can be used with name fields for enrichment

Default: null
contact_idstring

Unique identifier for the contact **Constraints:** can be used alone to enrich a contact

Default: null
domainstring

Website URL of the contact or their company **Constraints:** must be a valid domain format, without 'www.' or brackets {}; can be used with name fields for enrichment

Default: null
emailstring

Email address of the contact **Constraints:** can be used alone to enrich a contact

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
first_namestring

First name of the contact **Constraints:** must be used with last_name and either company_name or domain

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
full_namestring

Full name of the contact **Constraints:** must be used with either company_name or domain

Default: null
granularitystring

Time granularity for the returned values

Options:dailyweeklymonthly
Default: null
hashed_emailstring

Hashed email address of the contact (e.g., SHA256) **Constraints:** can be used alone to enrich a contact (MD5 hash)

Default: null
last_namestring

Last name of the contact **Constraints:** must be used with first_name and either company_name or domain

Default: null
linkedin_urlstring

LinkedIn profile URL of the contact **Constraints:** can be used alone to enrich a contact

Default: null

Post-contact-search-contacts

post-contact-search-contacts
Full Description

[contacts] Sales Contacts Search Search for sales contacts based on name, company, job title, seniority, department, and location filters.

Parameters (0 required, 27 optional)
Optional
ascboolean

Sort order direction **Constraints:** optional - set to true for ascending order, false or omit for descending

Default: null
cityarray

Contact city/cities to include in results

Default: null
city_notarray

Contact city/cities to exclude from results

Default: null
company_hq_countryarray

Company headquarters country/countries (two-letter country codes) **Constraints:** must be valid two-letter ISO country codes

Default: null
company_hq_country_notarray

Company headquarters country/countries to exclude **Constraints:** must be valid two-letter ISO country codes

Default: null
company_namearray

Exact company name(s) to include in results **Constraints:** must contain at least one non-empty company name

Default: null
company_name_containsstring

Partial company name match filter **Constraints:** must be a non-empty string

Default: null
company_name_notarray

Company name(s) to exclude from results **Constraints:** must contain at least one non-empty company name

Default: null
contacts_per_companyinteger

Limit numer of contacts per company in result **Constraints:** must be empty for no limits or between 1 and 1000

Default: null
countryarray

Contact country/countries (two-letter country codes) **Constraints:** must be valid two-letter ISO country codes

Default: null
country_notarray

Contact country/countries to exclude from results **Constraints:** must be valid two-letter ISO country codes

Default: null
departmentarray

Department(s) **Constraints:** must be one of: Sales, Engineering & Technical, Information Technology, Finance, Legal, Marketing, Medical & Health, Operations, Human Resources

Default: null
department_notarray

Department(s) to exclude **Constraints:** must be one of: Sales, Engineering & Technical, Information Technology, Finance, Legal, Marketing, Medical & Health, Operations, Human Resources

Default: null
domainarray

Company domain(s) to include in results **Constraints:** must contain at least one non-empty domain string, without 'www.' or brackets {}

Default: null
domain_containsstring

Partial domain match filter **Constraints:** must be a non-empty string

Default: null
domain_notarray

Company domain(s) to exclude from results **Constraints:** must contain at least one non-empty domain string, without 'www.' or brackets {}

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Options:dailyweeklymonthly
Default: null
has_contact_databoolean

Filter contacts that have email or phone number available **Constraints:** must be true (filtering for contacts without phone or email is not supported)

Default: null
has_emailboolean

Filter by email availability **Constraints:** must be true (filtering for contacts without email is not supported)

Default: null
has_mobile_phoneboolean

Filter by mobile phone availability **Constraints:** must be true (filtering for contacts without mobile phone is not supported)

Default: null
has_office_phoneboolean

Filter by office/direct phone availability **Constraints:** must be true (filtering for contacts without office phone is not supported)

Default: null
job_titlearray

Exact job title(s) to include in results **Constraints:** must contain at least one non-empty job title

Default: null
job_title_containsstring

Partial job title match filter **Constraints:** must be a non-empty string

Default: null
job_title_notarray

Job title(s) to exclude from results **Constraints:** must contain at least one non-empty job title

Default: null
limitinteger

Maximum number of results **Constraints:** must be between 1 and 100

Default: null

Post-contacts-bulk

post-contacts-bulk
Full Description

[contacts] Sales Contacts Bulk Enrichment Enrich up to 25 contacts in a single request with detailed data including email addresses, phone numbers, and professional details.

Parameters (0 required, 4 optional)
Optional
contactsarray

Array of contact matching inputs (1 to 25 items). Each item must provide a valid identifier combination. **Constraints:** must contain between 1 and 25 contact matching inputs; each item must provide one of: contact_id alone | email alone | hashed_email alone | linkedin_url alone | (first_name AND last_name AND (company_name OR domain)) | (full_name AND (company_name OR domain))

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Options:dailyweeklymonthly
Default: null

Post-emails-outreach

post-emails-outreach
Full Description

[sales] Generate AI-powered outreach emails for sales prospects. Generates personalized outreach emails using AI, tailored to the recipient's company and preferred metrics.

Parameters (1 required, 6 optional)
Required
companystring

Recipient's company name or domain. **Constraints:** must contain non-empty company name or domain

Optional
countrystring

Country code to tailor the outreach email. **Constraints:** must be valid two-letter ISO country codes

Default: null
emails_numberinteger

Number of outreach emails to generate. **Constraints:** must be between 1 and 5

Default: null
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago

Default: null
formatstring

Format in which the reply should be returned

Options:jsonxml
Default: null
granularitystring

Time granularity for the returned values

Options:dailyweeklymonthly
Default: null
languagestring

Language code for the outreach email.

Default: null