RequestBeam Docs
SimilarwebAPI endpoint reference
All 27 SimilarwebAPI GET endpoints with exact query names, types, limits, date windows, and response behavior.
All paths below are relative to your API origin. Every request requires Authorization: Bearer YOUR_API_KEY, uses GET, and has no request body. See authentication, billing, and errors.
Query Rules
The singular website fields key and Key require one ASCII domain such as amazon.com, up to 253 characters, without surrounding whitespace. Do not send a URL, IP address, domain list, or API credential in these fields. Use punycode for internationalized domains.
Query names are case-sensitive. Unknown fields, duplicate fields, CR/LF/NUL, and invalid values are rejected. Boolean values are literal true or false; zero is not interchangeable with false. Text is 1-2048 UTF-8 bytes after trimming. Encode spaces, JSON arrays, and separators with your HTTP client's query encoder.
from and to must occur together, be real calendar dates in YYYY-MM-DD or YYYY|MM|DD format, and satisfy from <= to. A comparison pair follows the same rule. Do not combine explicit dates with latest. Optional fields inherit endpoint defaults; the tables list allowed fields, not a requirement to send all of them.
Window-based routes normally default to 28 days ending three UTC days ago and accept latest=1d through 366d. Fixed-month routes have the defaults noted below. Engagement, visits, ranks, and channels additionally accept latest=1m|2m|3m|6m for previous complete UTC calendar months; these selectors require isWindow=false and default timeGranularity=Monthly. History has the narrower rules documented for its four endpoints.
Country 999 means worldwide; country 0 is preserved. Website identifiers are domains such as example.com, except the keyword-ranking endpoint where keys is a search keyword. Upstream data availability, filters, and matching types may vary.
Successful responses preserve native JSON rather than adopting a universal response schema. Incoming and outgoing referral tables use Records; historical metrics may use nested Data. The names and units described below do not imply every optional upstream field is always present.
Endpoints
Keyword suggestions
GET https://api.requestbeam.com/v1/similarweb/keywords/suggestions
Defaults: country 999, latest 28d, rowsPerPage 100, type Broad, websource Total, and windowVolume descending. Optional page is 1-based. rangeFilter uses native syntax, for example volume,100,10000|difficulty,0,40. Matching-type and filter availability depend on the data source.
| Query field | Required | Type and constraints |
|---|---|---|
keyword | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
sort | No | string; 1-2048 UTF-8 bytes after trimming |
asc | No | boolean string: true or false |
page | No | integer string; 1-1000 |
rowsPerPage | No | integer string; 1-1000 |
type | No | string; enum: Broad, Phrase, Exact, Related |
websource | No | string; enum: Total, Desktop, MobileWeb |
isWindow | No | boolean string: true or false |
rangeFilter | No | string; 1-2048 UTF-8 bytes after trimming |
Backlinks
GET https://api.requestbeam.com/v1/similarweb/websites/backlinks
Defaults: Page 1, PageSize 100, Status All, FollowType All, and DomainScore descending. Key is capitalized; do not use key or keys.
| Query field | Required | Type and constraints |
|---|---|---|
Key | Yes | string; 1-2048 UTF-8 bytes after trimming |
Page | No | integer string; 1-1000 |
PageSize | No | integer string; 1-1000 |
Status | No | string; enum: All, Active, New, Lost |
FollowType | No | string; enum: All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow |
DomainScoreFrom | No | integer string; 0-100 |
DomainScoreTo | No | integer string; 0-100 |
sort | No | string; 1-2048 UTF-8 bytes after trimming |
asc | No | boolean string: true or false |
Website keywords
GET https://api.requestbeam.com/v1/similarweb/websites/keywords
Defaults: page 1, pageSize 100, sourceType all, and both branded flags false. pageFilterJson is one URL-encoded JSON array string; when omitted it targets keys as a domain. latest=1m selects the one-month overview mode with pageSize 5 and isWindow=false unless explicitly provided. Use sourceType=organic or paid with IncludeNoneBranded=true and IncludeBranded=false for non-branded keyword views.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Daily, Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
sort | No | string; 1-2048 UTF-8 bytes after trimming |
asc | No | boolean string: true or false |
iso | No | string; 1-2048 UTF-8 bytes after trimming |
isDaily | No | boolean string: true or false |
IncludeBranded | No | boolean string: true or false |
IncludeNoneBranded | No | boolean string: true or false |
page | No | integer string; 1-1000 |
pageSize | No | integer string; 1-1000 |
sourceType | No | string; 1-2048 UTF-8 bytes after trimming |
pageFilterJson | No | string containing a JSON array |
Keyword ranking websites
GET https://api.requestbeam.com/v1/similarweb/keywords/websites
keys is a keyword, not a website domain. Defaults include selectedPageTab=Organic, sourceType=organic, Device=Total, and graphDuration=28d. Optional page and pageSize use 1-based/positive integers.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Daily, Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
sort | No | string; 1-2048 UTF-8 bytes after trimming |
asc | No | boolean string: true or false |
iso | No | string; 1-2048 UTF-8 bytes after trimming |
isDaily | No | boolean string: true or false |
tab | No | nonnegative integer string |
mtd | No | boolean string: true or false |
selectedPageTab | No | string; enum: Organic, Paid |
graphDuration | No | string; 1-2048 UTF-8 bytes after trimming |
graphType | No | integer string; 1-1000 |
isDurationChanged | No | boolean string: true or false |
ignoreFilterConsistency | No | boolean string: true or false |
Device | No | string; 1-2048 UTF-8 bytes after trimming |
sourceType | No | string; 1-2048 UTF-8 bytes after trimming |
page | No | integer string; 1-1000 |
pageSize | No | integer string; 1-1000 |
Traffic sources
GET https://api.requestbeam.com/v1/similarweb/websites/traffic-sources
Defaults: sourceType=Referral, page=1, orderBy=Share desc, and timeGranularity=Daily. This table is distinct from the incoming-referrals endpoint.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Daily, Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
sourceType | No | string; 1-2048 UTF-8 bytes after trimming |
ignoreFilterConsistency | No | boolean string: true or false |
page | No | integer string; 1-1000 |
orderBy | No | string; 1-2048 UTF-8 bytes after trimming |
Outgoing traffic
GET https://api.requestbeam.com/v1/similarweb/websites/outgoing-traffic
from and to are required. Singular key only. Defaults: country=999, isWWW=false, isWindow=false, webSource=Total, page=1, orderby=Share desc, orderBy=Share desc, sort=Share, asc=false. orderby and orderBy are distinct and forwarded independently; keep them consistent. No latest, pageSize, rowsPerPage, includeSubDomains, or timeGranularity. Rows are in Records; TotalCount is the upstream total, not the current page length.
| Query field | Required | Type and constraints |
|---|---|---|
key | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | Yes | string; valid date using the formats above |
to | Yes | string; valid date using the formats above |
isWWW | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
orderby | No | string; 1-2048 UTF-8 bytes after trimming |
orderBy | No | string; 1-2048 UTF-8 bytes after trimming |
sort | No | string; 1-2048 UTF-8 bytes after trimming |
asc | No | boolean string: true or false |
page | No | integer string; 1-1000 |
Incoming referrals
GET https://api.requestbeam.com/v1/similarweb/websites/incoming-referrals
Singular key only. Defaults: country=999, latest=28d, isWWW=false, isWindow=true, isDaily=false, webSource=Total, selectedTab=incomingTraffic, orderBy=TotalShare desc, ignoreFilterConsistency=false, page=1. No keys, pageSize, rowsPerPage, includeSubDomains, or timeGranularity. Rows are in Records; native fields may include SiteOrigins and TotalShare.
| Query field | Required | Type and constraints |
|---|---|---|
key | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
isWWW | No | boolean string: true or false |
iso | No | string; 1-2048 UTF-8 bytes after trimming |
isWindow | No | boolean string: true or false |
isDaily | No | boolean string: true or false |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
webSource | No | string; enum: Total, Desktop, MobileWeb |
selectedTab | No | string; enum: incomingTraffic |
orderBy | No | string; 1-2048 UTF-8 bytes after trimming |
ignoreFilterConsistency | No | boolean string: true or false |
page | No | integer string; 1-1000 |
Branded keyword share
GET https://api.requestbeam.com/v1/similarweb/websites/branded-keywords
Defaults to the previous complete UTC month. duration is fixed to 1m.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Daily, Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
duration | No | string; enum: 1m |
Traffic geography
GET https://api.requestbeam.com/v1/similarweb/websites/geography
Defaults to the previous three complete UTC months, pageSize=5 and orderBy=TotalShare desc.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Daily, Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
pageSize | No | integer string; 1-1000 |
orderBy | No | string; 1-2048 UTF-8 bytes after trimming |
Device distribution
GET https://api.requestbeam.com/v1/similarweb/websites/devices
Defaults to the previous three complete UTC months and ShouldGetVerifiedData=false.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Daily, Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
ShouldGetVerifiedData | No | boolean string: true or false |
Search performance
GET https://api.requestbeam.com/v1/similarweb/websites/search-performance
Defaults to the previous complete UTC month, pageSize=5, duration=1m and SourceType=Organic. Use SourceType=Paid for paid keywords; do not substitute sourceType.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Daily, Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
pageSize | No | integer string; 1-1000 |
duration | No | string; enum: 1m |
SourceType | No | string; enum: Organic, Paid |
Social traffic
GET https://api.requestbeam.com/v1/similarweb/websites/social-traffic
Defaults to the previous three complete UTC months. webSource is not accepted.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
timeGranularity | No | string; enum: Daily, Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
Engagement overview
GET https://api.requestbeam.com/v1/similarweb/websites/engagement
Defaults include ShouldGetVerifiedData=false, includeLeaders=true and unBounced=false. Native Data rows may contain AvgMonthVisits, BounceRate, PagesPerVisit and AvgVisitDuration.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Daily, Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
ShouldGetVerifiedData | No | boolean string: true or false |
includeLeaders | No | boolean string: true or false |
unBounced | No | boolean string: true or false |
beta | No | boolean string: true or false |
Total visits
GET https://api.requestbeam.com/v1/similarweb/websites/visits
compareFrom and compareTo must be supplied together as valid ordered dates. timeGranularity is Monthly. Native fields may include TotalVisits, Change and ShareOfVisits; a rolling total is not necessarily a complete-calendar-month total.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
compareFrom | No | string; valid date using the formats above |
compareTo | No | string; valid date using the formats above |
ShouldGetVerifiedData | No | boolean string: true or false |
Visits table
GET https://api.requestbeam.com/v1/similarweb/websites/visits/table
compareFrom and compareTo must be supplied together as valid ordered dates. timeGranularity is Monthly; rows are in Data, with Domain and TotalVisits. TotalCount can be 0 even when Data contains rows; inspect the array itself to determine whether results are present.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
compareFrom | No | string; valid date using the formats above |
compareTo | No | string; valid date using the formats above |
ShouldGetVerifiedData | No | boolean string: true or false |
Visits trend
GET https://api.requestbeam.com/v1/similarweb/websites/visits/trend
Defaults to the rolling 28-day daily window. timeGranularity accepts Daily, Weekly or Monthly.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Daily, Weekly, Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
ShouldGetVerifiedData | No | boolean string: true or false |
Website ranks
GET https://api.requestbeam.com/v1/similarweb/websites/ranks
timeGranularity is Monthly. Native response uses distinct GlobalRank, CountryRank and CategoryRank objects.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
Country ranks
GET https://api.requestbeam.com/v1/similarweb/websites/ranks/country
timeGranularity is Monthly. This is the explicit country-rank table, not the combined ranks response. Rows are in Data, with Domain and Rank. TotalCount can be 0 even when rows are present; inspect Data directly.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
Global ranks
GET https://api.requestbeam.com/v1/similarweb/websites/ranks/global
timeGranularity is Monthly. This returns the separate global-rank table. Rows are in Data, with Domain and Rank. TotalCount can be 0 even when rows are present; inspect Data directly.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
Category ranks
GET https://api.requestbeam.com/v1/similarweb/websites/ranks/category
timeGranularity is Monthly. This returns the separate industry/category-rank table. Rows are in Data, with Domain and Rank. TotalCount can be 0 even when rows are present; inspect Data directly.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
Traffic channels
GET https://api.requestbeam.com/v1/similarweb/websites/channels
Defaults to the rolling 28-day daily window. With webSource=Total, channel values are under Data.Total[domain], not directly under Data[domain]. Channel names are preserved, for example Search - Organic and Direct. Values are visit counts; derive shares only when their sum is positive.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Daily, Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
Similar sites
GET https://api.requestbeam.com/v1/similarweb/websites/similar-sites
Defaults to the previous three complete UTC months. isWindow must be false, timeGranularity is Monthly, and orderBy is fixed to Affinity desc. No latest or webSource.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
timeGranularity | No | string; enum: Monthly |
orderBy | No | string; enum: Affinity desc |
Similar site suggestions
GET https://api.requestbeam.com/v1/similarweb/websites/similar-sites/suggestions
Singular key; limit defaults to 20 and must be 1-20. country defaults to 999 and webSource to Total. The observed native response is an unwrapped array of candidates containing Domain, DomainWithoutSub, numeric Rank, and Favicon; do not expect a Data envelope. An empty array contains no suggestions.
| Query field | Required | Type and constraints |
|---|---|---|
key | Yes | string; 1-2048 UTF-8 bytes after trimming |
limit | No | integer string; 1-20 |
country | No | nonnegative integer string |
webSource | No | string; enum: Total, Desktop, MobileWeb |
Monthly visits history
GET https://api.requestbeam.com/v1/similarweb/websites/history/visits
Defaults to the previous six complete UTC months. Only country=999, isWindow=false and timeGranularity=Monthly are supported. latest accepts 1m through 6m; explicit dates must be complete months inside that rolling six-month window. Native series may appear under Data.<domain>.<source> with Key/Value points; source names, including MobileWeb or Mobile Web, are preserved. Values represent estimated visits.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
Monthly bounce rate history
GET https://api.requestbeam.com/v1/similarweb/websites/history/bounce-rate
Defaults to the previous six complete UTC months. Only country=999, isWindow=false and timeGranularity=Monthly are supported. latest accepts 1m through 6m; explicit dates must be complete months inside that rolling six-month window. Native series may appear under Data.<domain>.<source> with Key/Value points; source names, including MobileWeb or Mobile Web, are preserved. Values represent bounce-rate fractions.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
Monthly visit duration history
GET https://api.requestbeam.com/v1/similarweb/websites/history/visit-duration
Defaults to the previous six complete UTC months. Only country=999, isWindow=false and timeGranularity=Monthly are supported. latest accepts 1m through 6m; explicit dates must be complete months inside that rolling six-month window. Native series may appear under Data.<domain>.<source> with Key/Value points; source names, including MobileWeb or Mobile Web, are preserved. Values represent seconds per visit.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |
Monthly pages per visit history
GET https://api.requestbeam.com/v1/similarweb/websites/history/pages-per-visit
Defaults to the previous six complete UTC months. Only country=999, isWindow=false and timeGranularity=Monthly are supported. latest accepts 1m through 6m; explicit dates must be complete months inside that rolling six-month window. Native series may appear under Data.<domain>.<source> with Key/Value points; source names, including MobileWeb or Mobile Web, are preserved. Values represent pages per visit.
| Query field | Required | Type and constraints |
|---|---|---|
keys | Yes | string; 1-2048 UTF-8 bytes after trimming |
country | No | nonnegative integer string |
from | No | string; valid date using the formats above |
to | No | string; valid date using the formats above |
includeSubDomains | No | boolean string: true or false |
isWindow | No | boolean string: true or false |
webSource | No | string; enum: Total, Desktop, MobileWeb |
timeGranularity | No | string; enum: Monthly |
latest | No | string; 1-2048 UTF-8 bytes after trimming |