Skip to main content
GET
Reference example

Cost and request rules

Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.
  • Default request reference estimate (USD): 0.075
  • Declared unit rate (USD): 0.075
  • Billing unit: similarweb_credit
  • Cost contract: plan_units
  • Published reference multiplier: 1.0
  • Settlement evidence source: request_snapshot

Declared request billing units

  • Units: (metrics × periods) × 1
  • metrics: Number of entries in query.metrics, including repeated entries.
  • periods: Inclusive periods from query.start_date to query.end_date; granularity: query.granularity. Daily: inclusive days; weekly: inclusive days / 7 rounded up; monthly: inclusive calendar months.
  • Allowed granularities: [“monthly”]
  • Minimum: 1
  • Maximum: 12

Request constraints and usage notes

Authorizations

Authorization
string
header
required

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

Query Parameters

country
enum<string>
default:ww

Worldwide data only; values are case-insensitive.

Available options:
ww
end_date
string
required
format
enum<string>
Available options:
json
granularity
enum<string>
required
Available options:
monthly
main_domain_only
boolean
metrics
string
required
segment
string
required

Replace YOUR_SEGMENT_ID with a real segment ID available to the configured Similarweb account. Obtain it from that account's Similarweb user/predefined segment metadata or ask your AIsa operator. This is an account-dependent template, not a ready-to-run or upstream-verified example.

Required string length: 1 - 2048
start_date
string
required
web_source
enum<string>
Available options:
total

Response

Successful response