> ## Documentation Index
> Fetch the complete documentation index at: https://aisa.one/docs/llms.txt
> Use this file to discover all available pages before exploring further.
> ## Agent Instructions
> - Base URLs: models `https://api.aisa.one/v1` (Gemini GenerateContent: `https://api.aisa.one/v1beta`); data APIs `https://api.aisa.one/apis/v1`. The `servers` of each operation in https://aisa.one/openapi.yaml is authoritative.
> - Auth: `Authorization: Bearer $AISA_API_KEY`. Never print, log, or commit the key.
> - MCP (preferred for agents): `https://mcp.aisa.one/mcp`, signed in with OAuth, so there is no key to paste.
> - Agent Skill: `npx skills add AIsa-team/agent-skills --skill aisa`. Fallback with the AIsa CLI: `aisa skills install aisa`.
> - Spending: docs, https://aisa.one/models, https://aisa.one/api, `/v1/models`, and MCP `search`, `list_categories`, `get_details`, `batch_quote`, and the `account` operation are free. Quote the exact calls before running them (MCP `batch_quote`, CLI `aisa quote --json`). If the quote reports `auto_execute_eligible: true`, run it unless the user set a tighter limit or asked only for a quote. Otherwise, tell the user in one message the planned calls, the quoted price, and a total USD budget for the task, then wait for approval. Direct HTTP calls follow the stricter rule at https://aisa.one/docs/get-started/cli.md#direct-http-fallback. Do not make paid calls to test availability. Full rule: https://aisa.one/llms.txt
# Website Traffic Snapshot
> Website Traffic Snapshot — SimilarWeb
**First time?** Point any MCP client at `https://mcp.aisa.one/mcp` — Claude
Code, Codex, Cursor, VS Code and the rest. Authorization is OAuth: the client
opens a browser, you click Allow once, and there is no key to paste. Your
agent then reaches every endpoint through a few meta tools: `search`,
`list_categories`, `get_details` and `batch_quote` are free, `batch_use` is
billed per call. Setup per client is in
[Connect via MCP](/docs/agent-quickstart); the live tool list and what each call
costs are on [aisa.one/mcp](https://aisa.one/mcp#connect).
[Set this endpoint up in your agent →](https://aisa.one/mcp?from=/api-reference/similarweb/get_similarweb-website-traffic-snapshot)
## Request contract
* **Method and path:** GET /apis/v1/similarweb/website-traffic-snapshot
* **Availability:** enabled
* **Request URL template:** [https://api.aisa.one/apis/v1/similarweb/website-traffic-snapshot](https://api.aisa.one/apis/v1/similarweb/website-traffic-snapshot)
* **country:** query; optional
* **domain:** query; required
* **month:** query; optional
* **Runtime facts:** 472d1bfda50ffcb36fea4b8745e9822da1d9f0225a1e0e220b661005b2d4b7b2
[Complete OpenAPI definition](https://aisa.one/docs/openapi/similarweb.json)
Effective request and pricing declaration (including authentication and referenced schemas):
```json theme={null}
{
"operationId": "get_similarweb_website_traffic_snapshot",
"method": "GET",
"path": "/apis/v1/similarweb/website-traffic-snapshot",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [
{
"examples": {
"default": {
"value": "ww"
}
},
"in": "query",
"name": "country",
"required": false,
"schema": {
"default": "ww",
"description": "Worldwide data only; values are case-insensitive.",
"enum": [
"ww"
],
"type": "string"
}
},
{
"examples": {
"default": {
"value": "example.com"
},
"minimal": {
"value": "example.com"
}
},
"in": "query",
"name": "domain",
"required": true,
"schema": {
"description": "Bare website hostname without scheme, path, port, or credentials.",
"type": "string"
}
},
{
"examples": {
"default": {
"value": "2026-09"
}
},
"in": "query",
"name": "month",
"required": false,
"schema": {
"description": "Complete month in YYYY-MM.",
"type": "string",
"x-aisa-default-policy": "previous_complete_utc_month"
}
}
],
"security": [
{
"bearerAuth": []
}
],
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"cost_contract": "plan_units",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.3,
"estimate_source": "profile_seed",
"evidence_source": "request_snapshot",
"unit": "similarweb_credit",
"unit_rate_usd": 0.075
},
"components": {
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
```
## Cost and request rules
Usage-based billing; Default request estimate: \$0.3 USD (not a fixed price). Declared unit rate: \$0.075 USD per similarweb\_credit. Account-specific pricing and final settlement may differ.
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.3
* **Declared unit rate (USD):** 0.075
* **Billing unit:** similarweb\_credit
* **Cost contract:** plan\_units
* **Published reference multiplier:** 1.0
* **Settlement evidence source:** request\_snapshot
### Request constraints and usage notes
* country supports ww only; default ww.
* Monthly granularity only.
* Total web source and main domain only.
* Returns visits, bounce rate, pages per visit, and average visit duration.
* Provider usage is fixed at one month multiplied by four metrics.
## OpenAPI
````yaml openapi/similarweb.json GET /apis/v1/similarweb/website-traffic-snapshot
openapi: 3.1.0
info:
description: ''
title: SimilarWeb
version: '1'
x-aisa-capabilities:
idempotency: Idempotency-Key
max_price: X-AISA-Max-Price-USD
quote:
header: X-AISA-Cost-Mode
value: quote
x-aisa-catalogs:
similarweb:
description: ''
title: SimilarWeb
x-aisa-capabilities:
idempotency: Idempotency-Key
max_price: X-AISA-Max-Price-USD
quote:
header: X-AISA-Cost-Mode
value: quote
x-aisa-document:
facts_hash: 472d1bfda50ffcb36fea4b8745e9822da1d9f0225a1e0e220b661005b2d4b7b2
generator_version: '3'
protocol_version: '1'
schema_version: '1'
seed_month: 2026-09
x-aisa-plans:
builder: 1
display_plan: similarweb_payg
payg: 1
similarweb_payg: 1
team: 1
version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb
x-aisa-configured-paths:
- /apis/v1/similarweb/keyword-analysis/keywords/overview
- /apis/v1/similarweb/search/keyword-competitors
- /apis/v1/similarweb/search/landing-pages
- /apis/v1/similarweb/search/serp-players-aggregated
- /apis/v1/similarweb/search/serp-players-timeseries
- /apis/v1/similarweb/search/website-keywords
- /apis/v1/similarweb/segment-analysis/segments/traffic-and-engagement
- /apis/v1/similarweb/segment-analysis/segments/traffic-sources
- /apis/v1/similarweb/website-analysis/websites/conversion-rates
- /apis/v1/similarweb/website-analysis/websites/conversion-rates/aggregated
- >-
/apis/v1/similarweb/website-analysis/websites/traffic-by-demographics/aggregated
- /apis/v1/similarweb/website-top-geographies
- /apis/v1/similarweb/website-traffic-snapshot
- /apis/v1/similarweb/website-traffic-trend
- /apis/v1/similarweb/website/ad-networks
- /apis/v1/similarweb/website/audience-interest
- /apis/v1/similarweb/website/audience-overlap
- /apis/v1/similarweb/website/deduplicated-audience
- /apis/v1/similarweb/website/demographics
- /apis/v1/similarweb/website/folders
- /apis/v1/similarweb/website/marketing-channel-sources-legacy
- /apis/v1/similarweb/website/popular-pages
- /apis/v1/similarweb/website/ppc-spend
- /apis/v1/similarweb/website/ranking
- /apis/v1/similarweb/website/referrals
- /apis/v1/similarweb/website/similar-sites
- /apis/v1/similarweb/website/subdomains
- /apis/v1/similarweb/website/technologies
- /apis/v1/similarweb/website/top-sites-ranking
- /apis/v1/similarweb/website/traffic-engagement
x-aisa-document:
composer_version: '20'
document_hash: sha256:70f238cd4e5363c574833d61ae1adf9a983516b7540e672b8d7499183d4e4181
facts_hash: 472d1bfda50ffcb36fea4b8745e9822da1d9f0225a1e0e220b661005b2d4b7b2
generator_version: '3'
protocol_version: '1'
response_pending:
- method: GET
operation_id: get_similarweb_apis_v1_similarweb_keyword_analysi_490801
path: /apis/v1/similarweb/keyword-analysis/keywords/overview
reason: public success response has no authoritative payload declaration
statuses:
- '200'
- method: GET
operation_id: get_similarweb_apis_v1_similarweb_segment_analysi_6349fe
path: /apis/v1/similarweb/segment-analysis/segments/traffic-sources
reason: public success response has no authoritative payload declaration
statuses:
- '200'
- method: GET
operation_id: get_similarweb_apis_v1_similarweb_website_analysi_850464
path: /apis/v1/similarweb/website-analysis/websites/conversion-rates
reason: public success response has no authoritative payload declaration
statuses:
- '200'
- method: GET
operation_id: get_similarweb_apis_v1_similarweb_website_analysi_7399a9
path: >-
/apis/v1/similarweb/website-analysis/websites/conversion-rates/aggregated
reason: public success response has no authoritative payload declaration
statuses:
- '200'
- method: GET
operation_id: get_similarweb_apis_v1_similarweb_website_analysi_aa2e1f
path: >-
/apis/v1/similarweb/website-analysis/websites/traffic-by-demographics/aggregated
reason: public success response has no authoritative payload declaration
statuses:
- '200'
- method: GET
operation_id: similarwebFolders
path: /apis/v1/similarweb/website/folders
reason: public success response has no authoritative payload declaration
statuses:
- '200'
schema_version: '1'
seed_month: 2026-09
x-aisa-plans:
builder: 1
display_plan: similarweb_payg
payg: 1
similarweb_payg: 1
team: 1
version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb
x-aisa-provider: similarweb
servers:
- url: https://api.aisa.one
security:
- bearerAuth: []
paths:
/apis/v1/similarweb/website-traffic-snapshot:
get:
tags:
- website
summary: Website Traffic Snapshot
description: >-
Usage-based billing; Default request estimate: $0.3 USD (not a fixed
price). Declared unit rate: $0.075 USD per similarweb_credit.
Account-specific pricing and final settlement may differ.
operationId: get_similarweb_website_traffic_snapshot
parameters:
- examples:
default:
value: ww
in: query
name: country
required: false
schema:
default: ww
description: Worldwide data only; values are case-insensitive.
enum:
- ww
type: string
- examples:
default:
value: example.com
minimal:
value: example.com
in: query
name: domain
required: true
schema:
description: Bare website hostname without scheme, path, port, or credentials.
type: string
- examples:
default:
value: 2026-09
in: query
name: month
required: false
schema:
description: Complete month in YYYY-MM.
type: string
x-aisa-default-policy: previous_complete_utc_month
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
data:
additionalProperties: false
properties:
domain:
type: string
metrics:
additionalProperties: false
properties:
average_visit_duration:
type:
- number
- 'null'
bounce_rate:
type:
- number
- 'null'
pages_per_visit:
type:
- number
- 'null'
visits:
type:
- number
- 'null'
required:
- average_visit_duration
- bounce_rate
- pages_per_visit
- visits
type: object
month:
pattern: ^[0-9]{4}-[0-9]{2}$
type: string
required:
- domain
- month
- metrics
type: object
meta:
additionalProperties: false
properties:
country:
enum:
- ww
type: string
end_date:
pattern: ^[0-9]{4}-[0-9]{2}$
type: string
granularity:
const: monthly
type: string
request_id:
type: string
retrieved_at:
format: date-time
type: string
source:
const: similarweb
type: string
start_date:
pattern: ^[0-9]{4}-[0-9]{2}$
type: string
required:
- source
- request_id
- retrieved_at
- country
- granularity
- start_date
- end_date
type: object
required:
- data
- meta
type: object
description: Normalized successful response
default:
content:
application/json:
schema: {}
description: >-
Error response; upstream passthrough responses may use provider
formats
x-codeSamples:
- label: Reference example
lang: text
source: >-
# Fixed reference example. Playground inputs do not update this
sample.
curl --request GET \
--url 'https://api.aisa.one/apis/v1/similarweb/website-traffic-snapshot?country=ww&domain=example.com&month=2026-09' \
--header 'Authorization: Bearer '
components:
securitySchemes:
bearerAuth:
scheme: bearer
type: http
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.