Skip to main content
GET
Traffic & Engagement

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

domain
string
required

Target domain, e.g. example.com.

start_date
string
required

Start month, format YYYY-MM.

end_date
string
required

End month, format YYYY-MM.

granularity
enum<string>
default:monthly

Time granularity. Allowed: monthly. Default: monthly.

Available options:
monthly
metrics
string
required

Comma-separated metrics, e.g. visits,pages_per_visit.

country
enum<string>
default:ww

Two-letter country code. Allowed: us, ww. Default: ww. Coverage is limited to ww and us on the current plan.

Available options:
us,
ww
web_source
enum<string>

Traffic source device split. Allowed: desktop, mobile_web, total.

Available options:
desktop,
mobile_web,
total
main_domain_only
boolean
default:true

Restrict to the main domain only (true/false). Default: True.

mtd
boolean

Month-to-date flag (true/false).

Response

200 - application/json

SimilarWeb v5 envelope (meta + data).

meta
object

SimilarWeb v5 response envelope metadata.

data
object[]