Getting Started

Sections

Getting Started
- Introduction
- What's New in V5
- Authentication
- Making Your First Request
Guides
- Available Data
- Popular Use Cases
  - Recipes
- REST API vs Batch API
- API Pricing & Data Credits
  - Check Data Credits Balance
- Error Handling & Troubleshooting
- REST API Data Version Migration
API Reference
- Web Intelligence API
- Search Intelligence API
  - GET
    Website Keywords
  - GET
    SERP Players - Aggregated
- Amazon Intelligence
- Cross Retail Intelligence
- Sales Intelligence API
- App Intelligence API
- Gen AI Intelligence API
  - GET
    Prompt Tracking
Batch API Reference
- Set up your Batch API
- Batch API - Discovery
- Batch API - Datasets
- Batch API - Integrations
- Webhook Endpoints
  - POST
    Test Your Webhooks (GET)
Similarweb MCP
- Getting Started
- MCP Integrations
Support and FAQ
- FAQ
- Country Codes
- Check Capabilities
TrafficAndEngagement
- GET
  Traffic & Engagement
- GET
  /v5/website-analysis/websites/traffic-and-engagement/describe
TrafficSources
- GET
  Traffic Sources by Marketing Channel Overview
- GET
  /v5/website-analysis/websites/traffic-sources/describe
WebsiteRank
- GET
  Website Ranking
- GET
  /v5/website-analysis/websites/website-rank/describe
Subdomains
- GET
  Subdomains
- GET
  /v5/website-content/subdomains/describe
SimilarSites
- GET
  SimilarSites
- GET
  /v5/website-analysis/websites/similar-sites/describe
Referrals
- GET
  Referrals
- GET
  /v5/website-analysis/websites/referrals/describe
TrafficReferrals
- GET
  Aggregated Traffic Referrals
- GET
  /v5/website-analysis/websites/traffic-referrals/describe
- GET
  Incoming Traffic Referrals
- GET
  Outgoing Traffic Referrals
AudienceInterests
- GET
  Audience Interests
- GET
  /v5/website-analysis/websites/audience-interests/describe
AudienceOverlap
- GET
  Audience Overlap
- GET
  /v5/website-analysis/websites/audience-overlap/describe
DeduplicatedAudience
- GET
  Deduplicated Audience
- GET
  /v5/website-analysis/websites/deduplicated-audience/describe
LeadingFolders
- GET
  Folders
- GET
  /v5/website-content/pages/leading-folders/describe
PopularPages
- GET
  Popular Pages
- GET
  /v5/website-content/pages/popular-pages/describe
PpcSpend
- GET
  PPC Spend
- GET
  /v5/website-analysis/websites/ppc-spend/describe
Segments
- GET
  Get list of user segments.
- GET
  Segment Traffic and Engagement
- GET
  Segment Marketing Channels
AdNetworks
- GET
  Ad Networks
- GET
  /v5/website-analysis/ad-networks/describe
TrafficGeography
- GET
  Top Geographies
- GET
  /v5/website-analysis/websites/geography/describe
Technologies
- GET
  Website Technologies
- GET
  /v5/website-content/technologies/describe
Demographics
- GET
  Demographics Over Time
- GET
  Demographics
- GET
  /v5/website-analysis/websites/demographics/describe
- GET
  Demographic groups
TopSites
- GET
  /v1/TopSites/categories
- GET
  Top Sites
- GET
  /v5/website-analysis/websites/top-sites-by-category/describe
TrafficChannels
- GET
  Traffic Channels by Marketing Channel
- GET
  /v5/website-analysis/websites/traffic-channels/describe
- GET
  Traffic Channels Share
KeywordsOverview
- GET
  Keywords Overview
- GET
  /v5/keyword-analysis/keywords/overview/describe
KeywordSerpPlayers
- GET
  SERP players - Clicks over time
- GET
  SERP players
- GET
  /v5/keyword-analysis/websites/serp-players/describe
KeywordsCompetitors
- GET
  Keyword Competitors
- GET
  /v5/website-analysis/websites/keywords-competitors/describe
WebsiteKeywordsOverview
- GET
  /v4/websites/analysis/overview/branded-keywords-distribution
- GET
  /v4/websites/analysis/overview/describe
- GET
  Website Keywords
- GET
  /v5/website-analysis/keywords/seo-overview/describe
WebsiteKeywords
- GET
  /v4/website-analysis/keywords
- GET
  Website Keywords
- GET
  /v5/website-analysis/keywords/describe
WebsiteKeywordsLatest
- GET
  Website Keywords
- GET
  /v5/website-analysis/keywords/latest/describe
ConversionRates
- GET
  Conversion Rates Over Time
- GET
  Conversion Rates Aggregated
- GET
  /v5/website-analysis/websites/conversion-rates/describe
Citations
- GET
  GenAI Citation Analysis (URL-level)
Prompts
- GET
  Get AI tracker prompts data
- GET
  Get AI tracker aggregated prompts scoreboard
- GET
  /v5/gen-ai-campaign-analysis/prompts/describe
AdNetworkPublishers
- GET
  Top publishers carrying an advertiser's display ads within a specific ad network
- GET
  /v5/website-analysis/ad-network-publishers/aggregated/describe
AdNetworksByPublishers
- GET
  Top ad network × publisher pairs for an advertiser's display ad traffic
- GET
  /v5/website-analysis/ad-networks-by-publishers/aggregated/describe
PublishersByAdNetworks
- GET
  Publishers serving an advertiser's display ads, broken down by ad network
- GET
  /v5/website-analysis/publishers-by-ad-networks/aggregated/describe
OutgoingAdsAdvertisers
- GET
  Top advertisers placing display ads on a website
- GET
  /v5/website-analysis/outgoing-ads/advertisers/aggregated/describe
SocialTraffic
- GET
  Top social networks driving traffic to a website
- GET
  /v5/website-analysis/social-traffic/aggregated/describe
AppDetails
- GET
  /v1/app/{store}/{app-id}/details/describe
- GET
  /v1/app/{store}/{app-id}/details/details
- GET
  /v1/app/details/describe
- GET
  App Details
- GET
  /v5/app-analysis/apps/details/describe
AppRank
- GET
  /v1/app/{store}/{app-id}/rank/app-store-rank
- GET
  /v1/app/{store}/{app-id}/rank/describe
- GET
  /v1/app/rank/describe
AppRelatedSites
- GET
  /v1/app/{store}/{app-id}/RelatedSites/describe
- GET
  /v1/app/RelatedSites/describe
- GET
  /v4/app/{store}/{app-id}/RelatedSites/related-sites
AutoComplete
- GET
  /v1/app/{store}/find-app-name
AppDailyStickinessIos
- GET
  /v1/app/Apple/{app-id}/engagement/daily-stickiness
- GET
  /v1/app/Apple/engagement/daily-stickiness/describe
AppEngagementIos
- GET
  /v1/app/Apple/{app-id}/engagement/downloads
- GET
  /v1/app/Apple/{app-id}/engagement/mau
- GET
  /v1/app/Apple/engagement/describe
AppsRetention
- GET
  /v1/app/Google/{app-id}/AppRetention
- GET
  /v1/app/retention/Google/Describe
AppDemographics
- GET
  /v1/app/Google/{app-id}/demographics/age
- GET
  /v1/app/Google/{app-id}/demographics/gender
- GET
  /v1/app/Google/demographics/describe
AppEngagementAndroid
- GET
  /v1/app/Google/{app-id}/engagement/average-sessions-time
- GET
  /v1/app/Google/{app-id}/engagement/current-installs
- GET
  /v1/app/Google/{app-id}/engagement/daily-active-users
- GET
  /v1/app/Google/{app-id}/engagement/dau
- GET
  /v1/app/Google/{app-id}/engagement/downloads
- GET
  /v1/app/Google/{app-id}/engagement/install-penetration
- GET
  /v1/app/Google/{app-id}/engagement/mau
- GET
  /v1/app/Google/{app-id}/engagement/sessions-per-user
- GET
  /v1/app/Google/{app-id}/engagement/total-sessions-time
- GET
  /v1/app/Google/{app-id}/engagement/unique-installs
- GET
  /v1/app/Google/engagement/describe
AppDailyStickinessAndroid
- GET
  /v1/app/Google/{app-id}/engagement/daily-stickiness
- GET
  /v1/app/Google/engagement/daily-stickiness/describe
AppAudienceInterests
- GET
  /v1/app/Google/audience-interests/describe
- GET
  /v4/app/Google/{app-id}/audience-interests/also-used-apps
- GET
  App Audience Interests
- GET
  /v5/app-analysis/apps/audience-interests/describe
StoreTopApps
- GET
  /v1/appCategory/{store}/StoreRank/describe
- GET
  /v1/appCategory/StoreRank/describe
- GET
  /v4/appCategory/{store}/StoreRank/top-apps
UsageTopApps
- GET
  /v1/appCategory/{store}/UsageRank/describe
- GET
  /v1/appCategory/UsageRank/describe
- GET
  /v4/appCategory/{store}/UsageRank/top-apps
CompanyTrafficAndEngagement
- GET
  /v1/company/{company}/desktop-traffic-and-engagement/query
- GET
  /v1/company/{company}/mobile-traffic-and-engagement/query
- GET
  /v1/company/{company}/total-traffic-and-engagement/query
- GET
  /v1/company/traffic-and-engagement/describe
ConversionAnalysis
- GET
  /v1/segment/{segment}/conversion-analysis/query
- GET
  /v1/segment/conversion-analysis/describe
DesktopSegmentAnalysis
- GET
  /v1/segment/{segment}/marketing-channels/query
- GET
  /v1/segment/{segment}/traffic-and-engagement/query
- GET
  /v1/segment/marketing-channels/describe
- GET
  /v1/segment/traffic-and-engagement/describe
TotalSegmentAnalysis
- GET
  /v1/segment/{segment}/total-marketing-channels/query
- GET
  /v1/segment/{segment}/total-traffic-and-engagement/query
- GET
  /v1/segment/total-marketing-channels/describe
- GET
  /v1/segment/total-traffic-and-engagement/describe
LiteRank
- GET
  /v1/similar-rank/{domain}/rank
- GET
  /v1/similar-rank/top-sites
ApiWebhooks
- POST
  /v1/webhooks/authorize
- PUT
  /v1/webhooks/delete/{subscriptionId}
- POST
  /v1/webhooks/subscribe
- GET
  /v1/webhooks/subscriptions
- GET
  /v1/webhooks/subscriptions/all
- PUT
  /v1/webhooks/unsubscribe/{subscriptionId}
WebDesktopAudienceInterests
- GET
  /v1/website/{domain}/audience-interests/describe
- GET
  /v1/website/audience-interests/describe
- GET
  /v4/website/{domain}/audience-interests/also-visited
NewVsReturning
- GET
  /v1/website/{domain}/audience/total-new-vs-returning
- GET
  /v1/website/audience/total-new-vs-returning/describe
WebCategoryRank
- GET
  /v1/website/{domain}/category-rank/category-rank
- GET
  /v1/website/{domain}/category-rank/describe
- GET
  /v1/website/category-rank/describe
WebCountryRank
- GET
  /v1/website/{domain}/country-rank/country-rank
- GET
  /v1/website/{domain}/country-rank/describe
- GET
  /v1/website/country-rank/describe
WebDedup
- GET
  /v1/website/{domain}/dedup/deduplicated-audiences
- GET
  /v1/website/{domain}/dedup/describe
- GET
  /v1/website/dedup/describe
WebGeneralData
- GET
  /v1/website/{domain}/general-data/all
- GET
  /v1/website/{domain}/general-data/describe
- GET
  /v1/website/{domain}/general-data/description
- GET
  /v1/website/general-data/describe
WebGeo
- GET
  /v1/website/{domain}/Geo/describe
- GET
  /v1/website/Geo/describe
- GET
  /v4/website/{domain}/Geo/mobile-traffic-by-country
- GET
  /v4/website/{domain}/Geo/total-traffic-by-country
- GET
  /v4/website/{domain}/Geo/traffic-by-country
WebGlobalRank
- GET
  /v1/website/{domain}/global-rank/describe
- GET
  /v1/website/{domain}/global-rank/global-rank
- GET
  /v1/website/global-rank/describe
LeadEnrichment
- GET
  /v1/website/{domain}/lead-enrichment/all
- GET
  /v1/website/{domain}/lead-enrichment/describe
- GET
  /v1/website/lead-enrichment/describe
- GET
  Enrich Company
- GET
  /v5/sales-intelligence/lead-enrichment/describe
- GET
  Enrich Website
WebAudienceInterests
- GET
  /v1/website/{domain}/mobile-audience-interests/describe
- GET
  /v1/website/{domain}/total-audience-interests/describe
- GET
  /v1/website/mobile-audience-interests/describe
- GET
  /v1/website/total-audience-interests/describe
- GET
  /v4/website/{domain}/mobile-audience-interests/also-visited
- GET
  /v4/website/{domain}/total-audience-interests/also-visited
WebMobileTrafficSources
- GET
  /v1/website/{domain}/mobile-traffic-sources/describe
- GET
  /v1/website/mobile-traffic-sources/describe
- GET
  /v5/website/{domain}/mobile-traffic-sources/mobile-overview-share
AdSpend
- GET
  /v1/website/{domain}/ppc-spend/desktop
- GET
  /v1/website/{domain}/ppc-spend/total
- GET
  /v1/website/ppc-spend/desktop/describe
- GET
  /v1/website/ppc-spend/total/describe
WebSimilarSites
- GET
  /v1/website/{domain}/similar-sites/describe
- GET
  /v1/website/similar-sites/describe
- GET
  /v4/website/{domain}/similar-sites/similarsites
WebsiteTechnographics
- GET
  /v1/website/{domain}/technographics/describe
- GET
  /v1/website/lead-technographics/describe
- GET
  /v4/technographics/describe
- GET
  /v4/website/{domain}/technographics/all
WebTopSites
- GET
  /v1/website/{domain}/topsites/describe
- GET
  /v1/website/{domain}/topsites/topsites
- GET
  /v1/website/{domain}/topsites/topsitesinternal
- GET
  /v1/website/topsites/describe
- GET
  /v4/website/{domain}/topsites/desktop
- GET
  /v4/website/{domain}/topsites/mobile
- GET
  /v4/website/{domain}/topsites/total
WebTopSitesMobile
- GET
  /v1/website/{domain}/topsitesmobile/describe
- GET
  /v1/website/{domain}/topsitesmobile/topsites
- GET
  /v1/website/{domain}/topsitesmobile/topsitesinternal
- GET
  /v1/website/topsitesmobile/describe
WebTopSitesNew
- GET
  /v1/website/{domain}/total-topsites/describe
- GET
  /v1/website/total-topsites/describe
WebTotalTrafficAndEngagement
- GET
  /v1/website/{domain}/total-traffic-and-engagement/average-visit-duration
- GET
  /v1/website/{domain}/total-traffic-and-engagement/bounce-rate
- GET
  /v1/website/{domain}/total-traffic-and-engagement/describe
- GET
  /v1/website/{domain}/total-traffic-and-engagement/page-views
- GET
  /v1/website/{domain}/total-traffic-and-engagement/pages-per-visit
- GET
  /v1/website/{domain}/total-traffic-and-engagement/visits
- GET
  /v1/website/{domain}/total-traffic-and-engagement/visits-split
- GET
  /v1/website/total-traffic-and-engagement/describe
WebTrafficAndEngagement
- GET
  /v1/website/{domain}/traffic-and-engagement/average-visit-duration
- GET
  /v1/website/{domain}/traffic-and-engagement/bounce-rate
- GET
  /v1/website/{domain}/traffic-and-engagement/describe
- GET
  /v1/website/{domain}/traffic-and-engagement/page-views
- GET
  /v1/website/{domain}/traffic-and-engagement/pages-per-visit
- GET
  /v1/website/{domain}/traffic-and-engagement/visits
- GET
  /v1/website/traffic-and-engagement/describe
WebTrafficSources
- GET
  /v1/website/{domain}/traffic-sources/ad-networks-by-publishers
- GET
  /v1/website/{domain}/traffic-sources/describe
- GET
  /v1/website/{domain}/traffic-sources/engagement-metrics/average-duration
- GET
  /v1/website/{domain}/traffic-sources/engagement-metrics/bounce-rate
- GET
  /v1/website/{domain}/traffic-sources/engagement-metrics/pages-per-visit
- GET
  /v1/website/{domain}/traffic-sources/mobile-overview-share
- GET
  /v1/website/{domain}/traffic-sources/overview-share
- GET
  /v1/website/{domain}/traffic-sources/publishers-by-ad-networks
- GET
  /v1/website/traffic-sources/describe
- GET
  /v4/website/{domain}/traffic-sources/ad-network-publishers
- GET
  /v4/website/{domain}/traffic-sources/ad-networks
- GET
  /v4/website/{domain}/traffic-sources/mobileweb-outgoing-referrals
- GET
  /v4/website/{domain}/traffic-sources/mobileweb-referrals
- GET
  /v4/website/{domain}/traffic-sources/outgoing-ads-adnetworks
- GET
  /v4/website/{domain}/traffic-sources/outgoing-ads-advertisers
- GET
  /v4/website/{domain}/traffic-sources/outgoing-referrals
- GET
  /v4/website/{domain}/traffic-sources/overview
- GET
  /v4/website/{domain}/traffic-sources/publishers
- GET
  /v4/website/{domain}/traffic-sources/referrals
- GET
  /v4/website/{domain}/traffic-sources/social
WebUniqueVisitors
- GET
  /v1/website/{domain}/unique-visitors/describe
- GET
  /v1/website/{domain}/unique-visitors/desktop_mau
- GET
  /v1/website/{domain}/unique-visitors/desktop_unique_visitors
- GET
  /v1/website/{domain}/unique-visitors/mobileweb_mau
- GET
  /v1/website/{domain}/unique-visitors/mobileweb_unique_visitors
- GET
  /v1/website/unique-visitors/describe
WebWebsiteContentSubdomainsMobile
- GET
  /v1/website/{domain}/website-content-subdomains-mobile/describe
- GET
  /v1/website/website-content-subdomains-mobile/describe
- GET
  /v4/website/{domain}/website-content-subdomains-mobile/subdomains
WebWebsiteContentTotal
- GET
  /v1/website/{domain}/website-content-total/describe
- GET
  /v1/website/website-content-total/describe
- GET
  /v4/website/{domain}/website-content-total/leading-folders
WebWebsiteContent
- GET
  /v1/website/{domain}/website-content/describe
- GET
  /v1/website/{domain}/website-content/leading-folders
- GET
  /v1/website/website-content/describe
WebAudienceOverlap
- GET
  /v1/website/audience/overlap
- GET
  /v1/website/audience/overlap/Describe
WebSiteMobileWeb
- GET
  /v2/website/{domain}/mobile-web/average-visit-duration
- GET
  /v2/website/{domain}/mobile-web/bounce-rate
- GET
  /v2/website/{domain}/mobile-web/describe
- GET
  /v2/website/{domain}/mobile-web/page-views
- GET
  /v2/website/{domain}/mobile-web/pages-per-visit
- GET
  /v2/website/{domain}/mobile-web/visits
- GET
  /v2/website/mobile-web/describe
WebSearchCompetitors
- GET
  /v2/website/{domain}/search-competitors/describe
- GET
  /v2/website/search-competitors/describe
- GET
  /v4/website/{domain}/mobile-search-competitors/organicsearchcompetitors
- GET
  /v4/website/{domain}/mobile-search-competitors/paidsearchcompetitors
- GET
  /v4/website/{domain}/search-competitors/organicsearchcompetitors
- GET
  /v4/website/{domain}/search-competitors/paidsearchcompetitors
AppDemographicsOverTime
- GET
  /v4/app/{app-id}/demographics/age
- GET
  /v4/app/{app-id}/demographics/gender
- GET
  /v4/app/demographics/describe
AppDailyActiveUsers
- GET
  /v4/app/active-users/daily/describe
- GET
  /v4/app/Apple/{app-id}/active-users/daily-active-users
AppMonthlyActiveUsers
- GET
  /v4/app/Apple/{app-id}/active-users/monthly-active-users
- GET
  /v4/app/Apple/active-users/monthly/describe
AppWeeklyActiveUsers
- GET
  /v4/app/Apple/{app-id}/active-users/weekly-active-users
- GET
  /v4/app/Apple/active-users/weekly/describe
AppMonthlyActiveUsersControllerAndroid
- GET
  /v4/app/Google/{app-id}/active-users/monthly-active-users
- GET
  /v4/app/Google/active-users/monthly/describe
AppWeeklyActiveUsersAndroid
- GET
  /v4/app/Google/{app-id}/active-users/weekly-active-users
- GET
  /v4/app/Google/active-users/weekly/describe
KeywordSearchOverview
- GET
  /v4/keyword-search/keywords/overview/aggregated
- GET
  /v4/keyword-search/keywords/overview/describe
KeywordSearch
- GET
  /v4/keyword-search/websites/traffic
- GET
  /v4/keyword-search/websites/traffic/describe
KeywordAnalysisResearch
- GET
  /v4/keywords/{keyword}/analysis/competitors
- GET
  /v4/keywords/{keyword}/analysis/describe
- GET
  /v4/keywords/analysis/describe
KeywordsAnalysisOverview
- GET
  /v4/keywords/{keyword}/analysis/overview
- GET
  /v4/keywords/{keyword}/analysis/overview/describe
LandingPages
- GET
  /v4/keywords/landing-pages
- GET
  /v4/keywords/landing-pages/describe
- GET
  Landing Pages
- GET
  /v5/website-search/websites/landing-pages/describe
RankTrackerApiKeywordsReport
- GET
  /v4/rank-tracker/{campaign}/reports/keywords-report/detailed-trend
- GET
  /v4/rank-tracker/{campaign}/reports/keywords-report/Table
- GET
  /v4/rank-tracker/{campaign}/reports/keywords-report/Trend
- GET
  /v4/rank-tracker/reports/describe
RankTrackerApiOverviewReport
- GET
  /v4/rank-tracker/{campaign}/reports/overview-report/PerformanceOverTime
SalesSignals
- GET
  /v4/sales-signals/describe
- POST
  /v4/sales-signals/domains/list
- POST
  /v4/sales-signals/domains/subscribe
- POST
  /v4/sales-signals/domains/unsubscribe
- POST
  /v4/sales-signals/events/history
- POST
  /v4/sales-signals/events/resend
- POST
  /v4/sales-signals/signals/ad-network
- GET
  /v4/sales-signals/signals/all
- POST
  /v4/sales-signals/signals/archive
- POST
  /v4/sales-signals/signals/ecommerce
- POST
  /v4/sales-signals/signals/intent
- POST
  /v4/sales-signals/signals/news
- POST
  /v4/sales-signals/signals/technology
- POST
  /v4/sales-signals/signals/traffic
- POST
  /v4/sales-signals/webhook-subscriptions/add
- GET
  /v4/sales-signals/webhook-subscriptions/all
- POST
  /v4/sales-signals/webhook-subscriptions/archive
- POST
  /v4/sales-signals/webhook-subscriptions/authorize
ShopperSalesPerformance
- GET
  /v4/shopper/brand-category-sales-performance
- GET
  /v4/shopper/brand-top-products
- GET
  /v4/shopper/category-sales-performance
- GET
  /v4/shopper/category-top-brands
- GET
  Brand Sales Performance
- GET
  Brand Sales Performance
- GET
  Brand Top Products
- GET
  Brand Top Products
- GET
  Category Sales Performance
- GET
  Category Sales Performance
- GET
  Category Top Brands
- GET
  Category Top Brands
- GET
  Category Top Products
- GET
  Category Top Products
- GET
  Product Sales Performance
- GET
  Product Sales Performance
- GET
  /v5/shopper-sales/sales-performance/describe
ShopperOnSiteSearch
- GET
  /v4/shopper/brand-clicks-share
- GET
  /v4/shopper/brand-top-keywords
- GET
  /v4/shopper/category-top-keywords
- GET
  /v4/shopper/category-top-products
- GET
  /v4/shopper/keyword-sales-performance
- GET
  /v4/shopper/keywords-top-brands
- GET
  /v4/shopper/keywords-top-products
- GET
  /v4/shopper/oss/category-performance
- GET
  Brand Clicks Share
- GET
  Brand Clicks Share
- GET
  Brand Top Keywords
- GET
  Brand Top Keywords
- GET
  Category Performance
- GET
  Category Performance
- GET
  Category Top Keywords
- GET
  Category Top Keywords
- GET
  /v5/shopper-on-site-search/describe
- GET
  Keyword Performance
- GET
  Keyword Performance
- GET
  Keyword Top Brands
- GET
  Keyword Top Brands
- GET
  Keyword Top Products
- GET
  Keyword Top Products
- GET
  Product Top Keywords
- GET
  Product Top Keywords
ShopperProductOnSiteSearch
- GET
  /v4/shopper/oss/product-top-keywords
ShopperProductSalesPerformance
- GET
  /v4/shopper/product-sales-performance
WebDemographicSegments
- GET
  /v4/website/{domain}/demographics_v2/age
- GET
  /v4/website/{domain}/demographics_v2/describe
- GET
  /v4/website/{domain}/demographics_v2/gender
- GET
  /v4/website/{domain}/demographics_v2/groups
- GET
  /v4/website/demographics_v2/describe
WebRelatedApps
- GET
  /v4/website/{domain}/related-apps/describe
- GET
  /v4/website/{domain}/related-apps/related-apps
- GET
  /v4/website/related-apps/describe
WebWebsiteContentSubdomains
- GET
  /v4/website/{domain}/website-content-subdomains/subdomains
AppActiveUsers
- GET
  App Active Users
- GET
  /v5/app-analysis/apps/active-users/describe
KeywordRankHistory
- GET
  ASO Keyword Rank History
- GET
  /v5/app-analysis/apps/aso/keyword-rank-history/describe
AppAudienceDemographics
- GET
  App Audience Demographics
- GET
  /v5/app-analysis/apps/audience-demographics/describe
AppChangelog
- GET
  App Changelog
- GET
  /v5/app-analysis/apps/changelog/describe
AppDownloads
- GET
  App Downloads
- GET
  /v5/app-analysis/apps/downloads/describe
AppIabCategories
- GET
  App IAB Categories
- GET
  /v5/app-analysis/apps/iab-categories/describe
AppInstallPenetration
- GET
  App Install Penetration
- GET
  /v5/app-analysis/apps/install-penetration/describe
AppRanks
- GET
  App Ranks
- GET
  /v5/app-analysis/apps/ranks/describe
AppRatings
- GET
  App Ratings
- GET
  /v5/app-analysis/apps/ratings/describe
AppRetention
- GET
  App Retention
- GET
  /v5/app-analysis/apps/retention/describe
AppRevenue
- GET
  App Revenue
- GET
  /v5/app-analysis/apps/revenue/describe
AppSearch
- GET
  App Search
- GET
  /v5/app-analysis/apps/search/describe
AppSessions
- GET
  App Sessions
- GET
  /v5/app-analysis/apps/sessions/describe
AppSdks
- GET
  App Sdks
- GET
  /v5/app-analysis/apps/technographics-sdks/describe
AppsTopCharts
- GET
  Apps Top Charts
- GET
  /v5/app-analysis/apps/top-charts/describe
AppsIosActiveUsers
- GET
  /v5/apps/Apple/active-users
- GET
  /v5/apps/Apple/active-users/describe
AppsIosDownloads
- GET
  /v5/apps/Apple/downloads
- GET
  /v5/apps/Apple/downloads/describe
AppsIosSessions
- GET
  /v5/apps/Apple/sessions
- GET
  /v5/apps/Apple/sessions/describe
AppsAndroidActiveUsers
- GET
  /v5/apps/Google/active-users
- GET
  /v5/apps/Google/active-users/describe
AppsAndroidDownloads
- GET
  /v5/apps/Google/downloads
- GET
  /v5/apps/Google/downloads/describe
AppsAndroidSessions
- GET
  /v5/apps/Google/sessions
- GET
  /v5/apps/Google/sessions/describe
SalesContactsEnrichment
- POST
  Sales Contacts Enrichment
- POST
  Sales Contacts Bulk Enrichment
- GET
  /v5/contact-enrichment/contacts/describe
SalesContactsSearch
- POST
  Sales Contacts Search
- GET
  /v5/contact-search/contacts/describe
SearchTrends
- GET
  Search Trends
- GET
  Search Trends Aggregated
- GET
  Search Trends discovery
- GET
  Search Trends Keywords
- GET
  Search Trends Keywords Aggregated
AiTrafficLandingPages
- GET
  Get AI chatbot referral traffic per landing page
- GET
  Get data availability and supported LLM sources for the AI Traffic Landing Pages endpoint
AiTrafficOverview
- GET
  AI Traffic Overview
- GET
  AI Traffic Overview Aggregated
- GET
  Get supported countries and date ranges for the AI Traffic Overview endpoints.
IndustryAnalysis
- GET
  Get list of custom industries.
IndustryDemographics
- GET
  Industry Domains Age Distribution
- GET
  Industry Age Distribution
- GET
  Industry Demographics Valid Values
- GET
  Industry Domains Gender Shares
- GET
  Industry Gender Shares
IndustryUniqueUsers
- GET
  Industry Unique Users
- GET
  Industry Unique Users Valid Values
CriqAnalytics
- GET
  Search brands for a CRIQ custom category
- GET
  List retailer domains for a CRIQ custom category
- GET
  Get Cross Retail IQ (CRIQ) data availability, custom categories, and supported markets
- GET
  Check CRIQ catalog coverage for retailer domains
CriqOnSiteSearch
- GET
  List top on-site search keywords for a CRIQ custom category
- GET
  List top on-site search keywords for a CRIQ custom category (aggregated)
CriqPerformance
- GET
  Brand/Category performance for a CRIQ custom category
- GET
  Brand/Category performance for a CRIQ custom category (aggregated)
- GET
  List top brands for a CRIQ custom category
- GET
  List top brands for a CRIQ custom category (aggregated)
- GET
  List top products for a CRIQ custom category
- GET
  List top products for a CRIQ custom category (aggregated)
SalesAiOutreach
- POST
  Generate AI-powered outreach emails for sales prospects.
- GET
  /v5/sales-intelligence/emails/outreach/describe
SalesSignalsAdNetwork
- GET
  Get Ad Network Signals
SalesSignalsDescribe
- GET
  /v5/sales-intelligence/sales-signals/describe
SalesSignalsEcommerce
- GET
  Get Ecommerce Signals
SalesSignalsIntent
- GET
  Get Intent Signals
SalesSignalsNews
- GET
  Get News Signals
SalesSignalsTechnology
- GET
  Get Technology Signals
SalesSignalsTraffic
- GET
  Get Traffic Signals
ShopperBrandSearch
- GET
  Returns available data dates
- GET
  Search Brands
- GET
  Brands Top Competitors
- GET
  Brands Top Competitors
ShopperCategorySearch
- GET
  Search Categories
- GET
  /v5/shopper-analysis/categories/search/describe

API explorer

Theme switcher

ShopperOnSiteSearch

Was this section helpful?

Endpoints

GET

/v4/shopper/brand-clicks-share?limit=&offset=&asc=&sort=&brand=Nike&category=679182011&gra...

GET

/v4/shopper/brand-top-keywords?limit=&offset=&asc=&sort=&brand=Nike&category=679182011&gra...

GET

/v4/shopper/category-top-keywords?limit=&offset=&asc=&sort=&category=679182011&granularity...

GET

/v4/shopper/category-top-products?limit=&offset=&asc=&sort=&category=679182011&granularity...

GET

/v4/shopper/keyword-sales-performance?limit=&offset=&asc=&sort=&keyword=laptop&granularity...

GET

/v4/shopper/keywords-top-brands?limit=&offset=&asc=&sort=&keyword=laptop&granularity=Month...

GET

/v4/shopper/keywords-top-products?limit=&offset=&asc=&sort=&keyword=laptop&granularity=Mon...

GET

/v4/shopper/oss/category-performance?limit=&offset=&asc=&sort=&category=679182011&granular...

GET

/v5/shopper-on-site-search/brands/clicks/share?domain=amazon.com&granularity=Monthly&start...

GET

/v5/shopper-on-site-search/brands/clicks/share/aggregated?domain=amazon.com&granularity=Mo...

GET

/v5/shopper-on-site-search/brands/top-keywords?domain=amazon.com&granularity=Monthly&start...

GET

/v5/shopper-on-site-search/brands/top-keywords/aggregated?domain=amazon.com&granularity=Mo...

GET

/v5/shopper-on-site-search/categories/performance?domain=amazon.com&granularity=Monthly&st...

GET

/v5/shopper-on-site-search/categories/performance/aggregated?domain=amazon.com&granularity...

GET

/v5/shopper-on-site-search/categories/top-keywords?domain=amazon.com&granularity=Monthly&s...

GET

/v5/shopper-on-site-search/categories/top-keywords/aggregated?domain=amazon.com&granularit...

GET

/v5/shopper-on-site-search/describe

GET

/v5/shopper-on-site-search/keywords/performance?domain=amazon.com&granularity=Monthly&star...

GET

/v5/shopper-on-site-search/keywords/performance/aggregated?domain=amazon.com&granularity=M...

GET

/v5/shopper-on-site-search/keywords/top-brands?domain=amazon.com&granularity=Monthly&start...

GET

/v5/shopper-on-site-search/keywords/top-brands/aggregated?domain=amazon.com&granularity=Mo...

GET

/v5/shopper-on-site-search/keywords/top-products?domain=amazon.com&granularity=Monthly&sta...

GET

/v5/shopper-on-site-search/keywords/top-products/aggregated?domain=amazon.com&granularity=...

GET

/v5/shopper-on-site-search/products/top-keywords?domain=amazon.com&granularity=Monthly&sta...

GET

/v5/shopper-on-site-search/products/top-keywords/aggregated?domain=amazon.com&granularity=...

Was this section helpful?

View as Markdown

Ask an AI

Open in ChatGPT Open in ClaudeOpen in Perplexity

Code with AI

Open in Copilot