{ "components": { "callbacks": {}, "examples": {}, "headers": {}, "links": {}, "parameters": {}, "pathItems": {}, "requestBodies": {}, "responses": {}, "schemas": { "Response0Cee89220B8F_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "Response35F4A4Efeaa1_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "Response3716D452B70B_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "Response5186Bc180F5F_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "Response51Fe176F017A_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "Response62E957Bfd704_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "Response73D081Cabc11_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "Response758Fcfa4290B_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "Response7B51F63Afd06_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "Response80775Eb82C8B_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "Response876D22944B7A_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "Response87Ff1885565E_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "Response9A183Fe05Eb8_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "Response9E9628F8A247_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "ResponseA0396574Ebbb_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "ResponseBd0Df3C14905_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "ResponseC6C9032778Bd_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "ResponseE0D24A93E9A2_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "ResponseF53Baa954733_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" }, "ResponseFd1670723A17_SimilarWebMeta": { "description": "SimilarWeb v5 response envelope metadata.", "properties": { "last_updated": { "description": "Date of the most recent data point available upstream (YYYY-MM-DD).", "example": "2026-06-30", "type": "string" }, "query": { "description": "Pagination/sort echo when applicable (limit, offset, asc, sort).", "type": "object" }, "request": { "description": "Full echo of the normalized upstream request (parameters as received).", "type": "object" }, "status": { "description": "Upstream status; 'success' on a successful call.", "example": "success", "type": "string" } }, "required": [ "status" ], "type": "object" } }, "securitySchemes": { "bearerAuth": { "scheme": "bearer", "type": "http" } } }, "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.0, "display_plan": "similarweb_payg", "payg": 1.0, "similarweb_payg": 1.0, "team": 1.0, "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": "26", "document_hash": "sha256:d97d917894f7cda7e16364829692ec62bcedaa4afcc046be6ebe46db88938422", "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.0, "display_plan": "similarweb_payg", "payg": 1.0, "similarweb_payg": 1.0, "team": 1.0, "version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb" }, "x-aisa-provider": "similarweb" }, "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "openapi": "3.1.0", "paths": { "/apis/v1/similarweb/keyword-analysis/keywords/overview": { "get": { "description": "\n按用量计费；默认请求预估费用：$1.275 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_apis_v1_similarweb_keyword_analysi_490801", "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": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "format", "required": false, "schema": { "enum": [ "json" ], "type": "string" } }, { "examples": { "default": { "value": "monthly" }, "minimal": { "value": "monthly" } }, "in": "query", "name": "granularity", "required": true, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": "example" }, "minimal": { "value": "example" } }, "in": "query", "name": "keywords", "required": true, "schema": { "type": "string", "x-aisa-delimiter": ",", "x-aisa-maxItems": 20, "x-aisa-minItems": 1 } }, { "examples": { "default": { "value": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "total" ], "type": "string" } } ], "responses": { "200": { "description": "成功响应" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Keywords Overview", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb_apis_v1_similarweb_keyword_analysi_490801", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 1.275, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 20, "reserve_plan_units": { "input": "limit", "input_multiplier": 17 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "units_per_count": 17 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-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" ] }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "f21bb7c6b56f5c06dcb1a733a2dc5009cfbdc9e10b68ec9c5268baa637124bf2", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "a6201aa6c31a" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_apis_v1_similarweb_keyword_analysi_490801", "path": "/apis/v1/similarweb/keyword-analysis/keywords/overview" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/keyword-analysis/keywords/overview?country=ww&end_date=2026-09&granularity=monthly&keywords=example&limit=1&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/search/keyword-competitors": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.075 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_keyword_competitors", "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": { "maxLength": 253, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "required": false, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "offset", "required": false, "schema": { "maximum": 100000, "minimum": 0, "type": "integer" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "traffic_source", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "desktop", "mobile_web", "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "score": { "type": "number" }, "shared_keywords": { "type": "number" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/Response51Fe176F017A_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Keyword Competitors", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-search-keyword-competitors", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.075, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 20, "reserve_plan_units": { "input": "limit", "input_multiplier": 30000, "unit_rounding": "ceil", "unit_scale": 1000000 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "unit_rounding": "ceil", "units_per_count": 30000 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:1abacb0729f7be5d7fdf68170b774669f17be6c24c897223f7a71f62e8526427", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:4325953ba88dba06a446b82d66e3d5b3320e5f8a06e20df7738443497e4c9324", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:744b9d50b539e02fbb06f28ed5626ecbec689716fef47c089f6674e29470f36f", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "a138da82bdd3937b9e09a8b0fc56681c664eb5f7f48b47bad9425febadfea0bf", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "a138da82bdd3937b9e09a8b0fc56681c664eb5f7f48b47bad9425febadfea0bf", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "a138da82bdd3937b9e09a8b0fc56681c664eb5f7f48b47bad9425febadfea0bf", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "8fa1f556c136" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_keyword_competitors", "path": "/apis/v1/similarweb/search/keyword-competitors" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/search/keyword-competitors?country=ww&domain=example.com&end_date=2026-09&limit=1&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/search/landing-pages": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.075 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_landing_pages", "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": { "maxLength": 253, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "required": false, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "offset", "required": false, "schema": { "maximum": 100000, "minimum": 0, "type": "integer" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "traffic_source", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "desktop", "mobile_web", "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "ads": { "format": "int32", "type": [ "integer", "null" ] }, "clicks": { "type": "number" }, "desktop_share": { "format": "double", "type": [ "number", "null" ] }, "keywords": { "type": "integer" }, "mobile_share": { "format": "double", "type": [ "number", "null" ] }, "serp_features": { "description": "SERP features. The provider declares an array (or null), but its published item declaration is incomplete and differs from observed string elements. Element types are not yet confirmed; this field does not assert an item schema.", "type": [ "array", "null" ], "x-aisa-schema-status": "item_definition_unconfirmed" }, "spend": { "format": "double", "type": [ "number", "null" ] }, "top_keyword": { "type": [ "string", "null" ] }, "traffic_share": { "format": "double", "type": [ "number", "null" ] }, "url": { "example": "nike.com", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/Response5186Bc180F5F_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Landing Pages", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-search-landing-pages", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.075, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 20, "reserve_plan_units": { "input": "limit", "input_multiplier": 100000, "unit_rounding": "ceil", "unit_scale": 1000000 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "unit_rounding": "ceil", "units_per_count": 100000 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:b1bd17053f3efcd2d81645fdbc9ef347c1094a8f97d0db53dd0763359051c5cf", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:b17dc8da8923e0a918bd05104008923f26e0fe29142e8cca62bb9723ea937270", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:0fa4f2e54f8babfc0da75131f15491a87914969770b5f74eff42a3df92ce9bcc", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "a707c0144f9386ee7a2bfa48267dd62651848e6074ce27f348c0abaf9dc6dd8c", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_contract_review": { "authority_url": "https://docs.similarweb.com/api-v5/api-reference/search-analysis-api/landing-pages", "changes": [ { "after": { "example": "nike.com", "type": [ "string", "null" ] }, "before": { "type": "string" }, "field": "data[].url", "official_declaration": { "_id": "69fc30b696f4387d028036cf", "complexItems": [], "description": "", "isRequired": false, "items": [], "name": "url", "options": { "example": "nike.com", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "nike.com", "valueType": "string" } }, { "after": { "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].traffic_share", "official_declaration": { "_id": "69fc30b696f4387d028036d1", "complexItems": [], "description": "", "isRequired": false, "items": [], "name": "traffic_share", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "number" } }, { "after": { "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].desktop_share", "official_declaration": { "_id": "69fc30b696f4387d028036d2", "complexItems": [], "description": "", "isRequired": false, "items": [], "name": "desktop_share", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "number" } }, { "after": { "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].mobile_share", "official_declaration": { "_id": "69fc30b696f4387d028036d3", "complexItems": [], "description": "", "isRequired": false, "items": [], "name": "mobile_share", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "number" } }, { "after": { "type": [ "string", "null" ] }, "before": { "type": "string" }, "field": "data[].top_keyword", "official_declaration": { "_id": "69fc30b696f4387d028036d5", "complexItems": [], "description": "", "isRequired": false, "items": [], "name": "top_keyword", "options": { "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "string" } }, { "after": { "format": "double", "type": [ "number", "null" ] }, "before": { "type": "string" }, "field": "data[].spend", "official_declaration": { "_id": "69fc30b696f4387d028036d8", "complexItems": [], "description": "", "isRequired": false, "items": [], "name": "spend", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "number" } }, { "after": { "format": "int32", "type": [ "integer", "null" ] }, "before": { "type": "string" }, "field": "data[].ads", "official_declaration": { "_id": "69fc30b696f4387d028036d9", "complexItems": [], "description": "", "isRequired": false, "items": [], "name": "ads", "options": { "format": "int32", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "integer" } } ], "file": "openapi/upstream/response-similarweb-get-ae32620e11d1169e.json", "partial_array_declaration": { "after": { "description": "SERP features. The provider declares an array (or null), but its published item declaration is incomplete and differs from observed string elements. Element types are not yet confirmed; this field does not assert an item schema.", "type": [ "array", "null" ], "x-aisa-schema-status": "item_definition_unconfirmed" }, "before": { "type": "string" }, "field": "data[].serp_features", "known": "Official valueType array, options.nullable true; current live samples also have an array.", "unknown": "Official nested array item has no item schema; observed items are strings. No item type is inferred." }, "public_path": "/apis/v1/similarweb/search/landing-pages", "raw_content_hash": "sha256:cf0a0709a5c08ce04be1e6c120a3bb0d4587cda305e115c040d6bd423cd49b46", "unresolved": [ "serp_features element type remains unconfirmed; only array-or-null container type is asserted." ], "upstream_path": "/v5/website-search/websites/landing-pages/aggregated" }, "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "a707c0144f9386ee7a2bfa48267dd62651848e6074ce27f348c0abaf9dc6dd8c", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "a707c0144f9386ee7a2bfa48267dd62651848e6074ce27f348c0abaf9dc6dd8c", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "9e76c6b19d92" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_landing_pages", "path": "/apis/v1/similarweb/search/landing-pages" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/search/landing-pages?country=ww&domain=example.com&end_date=2026-09&limit=1&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/search/serp-players-aggregated": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.075 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_serp_players_aggregated", "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": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "required": false, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": "example" }, "minimal": { "value": "example" } }, "in": "query", "name": "keywords", "required": true, "schema": { "type": "string", "x-aisa-delimiter": ",", "x-aisa-maxItems": 1, "x-aisa-minItems": 1 } }, { "examples": { "default": { "value": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "maximum": 100000, "minimum": 0, "type": "integer" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "clicks": { "description": "Sum of clicks the domain receives for the analyzed keyword", "format": "double", "type": [ "number", "null" ] }, "domain": { "description": "Website domain without 'www.' (e.g., 'example.com')", "type": [ "string", "null" ] }, "serp_features": { "description": "SERP features. The provider declares an array (or null), but its published item declaration is incomplete and differs from observed string elements. Element types are not yet confirmed; this field does not assert an item schema.", "type": [ "array", "null" ], "x-aisa-schema-status": "item_definition_unconfirmed" }, "site": { "description": "Website sub-domain without 'www.' (e.g., 'developer.example.com')", "type": [ "string", "null" ] }, "top_url": { "description": "The site url with the highest organic position that ranks for the analyzed keyword", "type": [ "string", "null" ] }, "top_url_position": { "description": "Top latest blended position of the *top_url* in the selected timeframe", "format": "int32", "type": [ "integer", "null" ] }, "traffic_share": { "description": "The share of the traffic to the website", "format": "double", "type": [ "number", "null" ] } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/Response62E957Bfd704_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "SERP Players - Aggregated", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-search-serp-players-aggregated", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.075, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 20, "reserve_plan_units": { "input": "limit", "input_multiplier": 70000, "unit_rounding": "ceil", "unit_scale": 1000000 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "unit_rounding": "ceil", "units_per_count": 70000 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:2adc82cc7284f7ed84163c2bfcd8d5e093083ec82ed488a7a675d3c0f020e4a7", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:febbc92f2dd8bf4130fc69fe5adcffe80755797e4e6c913d82fcaff0108ac9fa", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:2922e56bab3c2db61dff68474a8735bbe5d1bf5c5ee5f5f1257d3ceb14cf54c4", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "60aedbb659fb3099a1726dd0749185e0e8bbe5ce64c627d792404a4c107363b5", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_contract_review": { "authority_url": "https://docs.similarweb.com/api-v5/api-reference/search-analysis-api/serp-players-aggregated", "changes": [ { "after": { "description": "Website sub-domain without 'www.' (e.g., 'developer.example.com')", "type": [ "string", "null" ] }, "before": { "type": "string" }, "field": "data[].site", "official_declaration": { "_id": "69fc30b296f4387d02803629", "complexItems": [], "description": "Website sub-domain without 'www.' (e.g., 'developer.example.com')", "isRequired": false, "items": [], "name": "site", "options": { "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "string" } }, { "after": { "description": "Website domain without 'www.' (e.g., 'example.com')", "type": [ "string", "null" ] }, "before": { "type": "string" }, "field": "data[].domain", "official_declaration": { "_id": "69fc30b296f4387d0280362a", "complexItems": [], "description": "Website domain without 'www.' (e.g., 'example.com')", "isRequired": false, "items": [], "name": "domain", "options": { "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "string" } }, { "after": { "description": "Sum of clicks the domain receives for the analyzed keyword", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].clicks", "official_declaration": { "_id": "69fc30b296f4387d0280362b", "complexItems": [], "description": "Sum of clicks the domain receives for the analyzed keyword", "isRequired": false, "items": [], "name": "clicks", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "number" } }, { "after": { "description": "The share of the traffic to the website", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].traffic_share", "official_declaration": { "_id": "69fc30b296f4387d0280362c", "complexItems": [], "description": "The share of the traffic to the website", "isRequired": false, "items": [], "name": "traffic_share", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "number" } }, { "after": { "description": "Top latest blended position of the *top_url* in the selected timeframe", "format": "int32", "type": [ "integer", "null" ] }, "before": { "type": "integer" }, "field": "data[].top_url_position", "official_declaration": { "_id": "69fc30b296f4387d0280362f", "complexItems": [], "description": "Top latest blended position of the *top_url* in the selected timeframe", "isRequired": false, "items": [], "name": "top_url_position", "options": { "format": "int32", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "integer" } }, { "after": { "description": "The site url with the highest organic position that ranks for the analyzed keyword", "type": [ "string", "null" ] }, "before": { "type": "string" }, "field": "data[].top_url", "official_declaration": { "_id": "69fc30b296f4387d02803630", "complexItems": [], "description": "The site url with the highest organic position that ranks for the analyzed keyword", "isRequired": false, "items": [], "name": "top_url", "options": { "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "string" } } ], "file": "openapi/upstream/response-similarweb-get-33ae43399145c1f1.json", "partial_array_declaration": { "after": { "description": "SERP features. The provider declares an array (or null), but its published item declaration is incomplete and differs from observed string elements. Element types are not yet confirmed; this field does not assert an item schema.", "type": [ "array", "null" ], "x-aisa-schema-status": "item_definition_unconfirmed" }, "before": { "type": "string" }, "field": "data[].serp_features", "known": "Official valueType array, options.nullable true; current live samples also have an array.", "unknown": "Official nested array item has no item schema; observed items are strings. No item type is inferred." }, "public_path": "/apis/v1/similarweb/search/serp-players-aggregated", "raw_content_hash": "sha256:9a3e0f4329b26822580d5b7cfae4ba1ee937928d7f2cf9b744e2a033f38e9189", "unresolved": [ "serp_features element type remains unconfirmed; only array-or-null container type is asserted." ], "upstream_path": "/v5/keyword-analysis/websites/serp-players/aggregated" }, "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "60aedbb659fb3099a1726dd0749185e0e8bbe5ce64c627d792404a4c107363b5", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "60aedbb659fb3099a1726dd0749185e0e8bbe5ce64c627d792404a4c107363b5", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "a84c24f9797f" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_serp_players_aggregated", "path": "/apis/v1/similarweb/search/serp-players-aggregated" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/search/serp-players-aggregated?country=ww&end_date=2026-09&keywords=example&limit=1&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/search/serp-players-timeseries": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.075 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_serp_players_timeseries", "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": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "required": false, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": "example" }, "minimal": { "value": "example" } }, "in": "query", "name": "keywords", "required": true, "schema": { "type": "string", "x-aisa-delimiter": ",", "x-aisa-maxItems": 1, "x-aisa-minItems": 1 } }, { "examples": { "default": { "value": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "maximum": 100000, "minimum": 0, "type": "integer" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "clicks": { "type": "integer" }, "date": { "type": "string" }, "domain": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/Response35F4A4Efeaa1_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "SERP Players - Clicks over time", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-search-serp-players-timeseries", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.075, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 20, "reserve_plan_units": { "input": "limit", "input_multiplier": 20000, "unit_rounding": "ceil", "unit_scale": 1000000 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "unit_rounding": "ceil", "units_per_count": 20000 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:e60b07eda5318495caab5ab246e47f3bb976c631b1ac7f2c80380535d5dbea3b", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:e1f10b91c218e715e7daf14a467e0bbd9e850b56fdf5bfaa6b61a8649eaf323d", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:38b31cd69cd35a34b081bd6c1717a1f78ecc4f1ecd67e450c32c5be526963dfe", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "9aaa25317d8fc468e437332d42a0577079db226511697a20cdf92817fa13bd94", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "9aaa25317d8fc468e437332d42a0577079db226511697a20cdf92817fa13bd94", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "9aaa25317d8fc468e437332d42a0577079db226511697a20cdf92817fa13bd94", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "28a3ac82cda9" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_serp_players_timeseries", "path": "/apis/v1/similarweb/search/serp-players-timeseries" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/search/serp-players-timeseries?country=ww&end_date=2026-09&keywords=example&limit=1&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/search/website-keywords": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.075 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_keywords", "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": { "maxLength": 2048, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "format", "required": false, "schema": { "enum": [ "json" ], "type": "string" } }, { "examples": { "default": { "value": "monthly" }, "minimal": { "value": "monthly" } }, "in": "query", "name": "granularity", "required": true, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "clicks": { "description": "The number of keyword search clicks to the website", "format": "double", "type": [ "number", "null" ] }, "competition": { "description": "Competition level for ad placement on the keyword.", "format": "int32", "type": [ "integer", "null" ] }, "keyword": { "description": "A single keyword or name of a keyword group to analyze", "type": [ "string", "null" ] }, "position": { "description": "The keyword's latest universal position within the selected time range. Not avaialble for 'world' country.", "format": "int32", "type": [ "integer", "null" ] }, "primary_intent": { "description": "An estimation of what peaople searching for this keywords are trying to acheive.", "type": [ "string", "null" ] }, "secondary_intent": { "description": "Secondary intent for keyword search.", "type": [ "string", "null" ] }, "serp_features": { "description": "SERP features. The provider declares an array (or null), but its published item declaration is incomplete and differs from observed string elements. Element types are not yet confirmed; this field does not assert an item schema.", "type": [ "array", "null" ], "x-aisa-schema-status": "item_definition_unconfirmed" }, "top_url": { "description": "The site url with the highest organic position that ranks for the analyzed keyword", "type": [ "string", "null" ] }, "traffic_share": { "description": "The share of the traffic to the website", "format": "double", "type": [ "number", "null" ] }, "url_count": { "description": "Number of URLs for the keyword", "format": "int32", "type": [ "integer", "null" ] } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/ResponseF53Baa954733_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Website Keywords", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-search-website-keywords", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.075, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 20, "reserve_plan_units": { "input": "limit", "input_multiplier": 100000, "unit_rounding": "ceil", "unit_scale": 1000000 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "unit_rounding": "ceil", "units_per_count": 100000 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:a23c63ed0596816070a4a00f24fcf14f843aab7413564f1792fe1918f69e610b", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:e4f51f3b5f29e42d7ec0578dc159fbeef4635b0249e4d430108d6d57b6a081af", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:a832bbface4226a43cecfb77141b39a79f804bc1db2d54c8dfc422dcb3d000e9", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "e4469a00f4fd983e1efd530bafb4166508310104b4112aecc98faf3c28b6f157", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_contract_review": { "authority_url": "https://docs.similarweb.com/api-v5/api-reference/search-analysis-api/website-keywords", "changes": [ { "after": { "description": "A single keyword or name of a keyword group to analyze", "type": [ "string", "null" ] }, "before": { "type": "string" }, "field": "data[].keyword", "official_declaration": { "_id": "69fc334096f4387d02805405", "complexItems": [], "description": "A single keyword or name of a keyword group to analyze", "isRequired": false, "items": [], "name": "keyword", "options": { "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "string" } }, { "after": { "description": "The number of keyword search clicks to the website", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].clicks", "official_declaration": { "_id": "69fc334096f4387d02805406", "complexItems": [], "description": "The number of keyword search clicks to the website", "isRequired": false, "items": [], "name": "clicks", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "number" } }, { "after": { "description": "The share of the traffic to the website", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].traffic_share", "official_declaration": { "_id": "69fc334096f4387d02805407", "complexItems": [], "description": "The share of the traffic to the website", "isRequired": false, "items": [], "name": "traffic_share", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "number" } }, { "after": { "description": "Competition level for ad placement on the keyword.", "format": "int32", "type": [ "integer", "null" ] }, "before": { "type": "integer" }, "field": "data[].competition", "official_declaration": { "_id": "69fc334096f4387d02805408", "complexItems": [], "description": "Competition level for ad placement on the keyword.", "isRequired": false, "items": [], "name": "competition", "options": { "format": "int32", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "integer" } }, { "after": { "description": "An estimation of what peaople searching for this keywords are trying to acheive.", "type": [ "string", "null" ] }, "before": { "type": "string" }, "field": "data[].primary_intent", "official_declaration": { "_id": "69fc334096f4387d02805409", "complexItems": [], "description": "An estimation of what peaople searching for this keywords are trying to acheive.", "isRequired": false, "items": [], "name": "primary_intent", "options": { "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "string" } }, { "after": { "description": "Secondary intent for keyword search.", "type": [ "string", "null" ] }, "before": { "type": "string" }, "field": "data[].secondary_intent", "official_declaration": { "_id": "69fc334096f4387d0280540a", "complexItems": [], "description": "Secondary intent for keyword search.", "isRequired": false, "items": [], "name": "secondary_intent", "options": { "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "string" } }, { "after": { "description": "The keyword's latest universal position within the selected time range. Not avaialble for 'world' country.", "format": "int32", "type": [ "integer", "null" ] }, "before": { "type": "integer" }, "field": "data[].position", "official_declaration": { "_id": "69fc334096f4387d0280540b", "complexItems": [], "description": "The keyword's latest universal position within the selected time range. Not avaialble for 'world' country.", "isRequired": false, "items": [], "name": "position", "options": { "format": "int32", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "integer" } }, { "after": { "description": "The site url with the highest organic position that ranks for the analyzed keyword", "type": [ "string", "null" ] }, "before": { "type": "string" }, "field": "data[].top_url", "official_declaration": { "_id": "69fc334096f4387d0280540e", "complexItems": [], "description": "The site url with the highest organic position that ranks for the analyzed keyword", "isRequired": false, "items": [], "name": "top_url", "options": { "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "string" } }, { "after": { "description": "Number of URLs for the keyword", "format": "int32", "type": [ "integer", "null" ] }, "before": { "type": "integer" }, "field": "data[].url_count", "official_declaration": { "_id": "69fc334096f4387d0280540f", "complexItems": [], "description": "Number of URLs for the keyword", "isRequired": false, "items": [], "name": "url_count", "options": { "format": "int32", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "integer" } } ], "file": "openapi/upstream/response-similarweb-get-9820d168b26837f7.json", "partial_array_declaration": { "after": { "description": "SERP features. The provider declares an array (or null), but its published item declaration is incomplete and differs from observed string elements. Element types are not yet confirmed; this field does not assert an item schema.", "type": [ "array", "null" ], "x-aisa-schema-status": "item_definition_unconfirmed" }, "before": { "type": "string" }, "field": "data[].serp_features", "known": "Official valueType array, options.nullable true; current live samples also have an array.", "unknown": "Official nested array item has no item schema; observed items are strings. No item type is inferred." }, "public_path": "/apis/v1/similarweb/search/website-keywords", "raw_content_hash": "sha256:fc2981657888589811df878e0687ba8470e2f694318b0d0a10cfb6527db52c8e", "unresolved": [ "serp_features element type remains unconfirmed; only array-or-null container type is asserted." ], "upstream_path": "/v5/website-analysis/keywords/aggregated" }, "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "e4469a00f4fd983e1efd530bafb4166508310104b4112aecc98faf3c28b6f157", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "e4469a00f4fd983e1efd530bafb4166508310104b4112aecc98faf3c28b6f157", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "5d66e184ee71" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_keywords", "path": "/apis/v1/similarweb/search/website-keywords" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/search/website-keywords?country=ww&domain=example.com&end_date=2026-09&granularity=monthly&limit=1&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/segment-analysis/segments/traffic-and-engagement": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.075 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_apis_v1_similarweb_segment_analysi_64e47c", "parameters": [ { "examples": { "default": { "value": "ww" }, "minimal": { "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": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "format", "required": false, "schema": { "enum": [ "json" ], "type": "string" } }, { "examples": { "default": { "value": "monthly" }, "minimal": { "value": "monthly" } }, "in": "query", "name": "granularity", "required": true, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "examples": { "default": { "value": "visits" }, "minimal": { "value": "visits" } }, "in": "query", "name": "metrics", "required": true, "schema": { "type": "string", "x-aisa-delimiter": ",", "x-aisa-maxItems": 8, "x-aisa-minItems": 1 } }, { "examples": { "default": { "value": "YOUR_SEGMENT_ID" }, "minimal": { "value": "YOUR_SEGMENT_ID" } }, "in": "query", "name": "segment", "required": true, "schema": { "description": "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.", "maxLength": 2048, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "average_visit_duration": { "description": "Average time on website (in seconds)", "format": "double", "type": [ "number", "null" ] }, "bounce_rate": { "description": "Percentage of visits that view only one page on the website", "example": "0.15913776", "format": "double", "type": [ "number", "null" ] }, "confidence": { "enum": [ "high", "low", "very_low" ], "type": "string" }, "date": { "description": "Date of the requested data in 'YYYY-MM' or 'YYYY-MM-DD' format", "example": "2025-10-01", "format": "date-time", "type": "string" }, "page_views": { "description": "Estimated number of pages viewed on the website", "example": "2641.4065", "format": "double", "type": [ "number", "null" ] }, "pages_per_visit": { "description": "Average number of pages viewed per visit", "example": "0.9947667", "format": "double", "type": [ "number", "null" ] }, "share": { "description": "Percentage of total site traffic that comes from this segment", "example": "0.014075259", "format": "double", "type": [ "number", "null" ] }, "unique_visitors": { "description": "Estimated number of unique visitors (not deduplicated across devices) to the website", "example": "1834.0046", "format": "double", "type": [ "number", "null" ] }, "visits": { "description": "Estimated number of visits to the website", "example": "2655.3025", "format": "double", "type": [ "number", "null" ] } }, "type": [ "object", "null" ] }, "type": [ "array", "null" ] }, "meta": { "properties": { "data_type": { "enum": [ "not_applicable", "estimated", "verified" ], "type": "string" }, "error_code": { "example": "200", "format": "int32", "type": [ "integer", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "last_updated": { "example": "2025-10-30", "format": "date-time", "type": [ "string", "null" ] }, "request": { "properties": { "country": { "description": "Two-letter country code (e.g., 'us', 'gb', 'ww')", "example": "us", "type": [ "string", "null" ] }, "end_date": { "description": "End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago", "example": "2025-10-30", "format": "date-time", "type": [ "string", "null" ] }, "format": { "description": "Format in which the reply should be returned", "enum": [ "json", "xml" ], "type": "string" }, "granularity": { "description": "Time granularity for the returned values", "enum": [ "daily", "weekly", "monthly" ], "example": "monthly", "type": "string" }, "metrics": { "description": "Comma-separated list of metrics: visits, bounce_rate, page_views, average_visit_duration, pages_per_visit, share, unique_visitors", "items": { "enum": [ "visits", "bounce_rate", "page_views", "average_visit_duration", "pages_per_visit", "share", "unique_visitors" ], "type": "string" }, "type": [ "array", "null" ] }, "mtd": { "description": "When 'true', end_date is set to the latest available days' data (month-to-date). To use, set granularity to 'daily'", "type": "boolean" }, "segment": { "description": "Segment ID to analyze", "example": "a4a9eadc-09ff-4f0b-beb2-40f7c5d07599", "minLength": 1, "type": "string" }, "start_date": { "description": "Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago", "example": "2025-10-01", "format": "date-time", "type": [ "string", "null" ] }, "web_source": { "description": "The device/platform the traffic is coming from", "enum": [ "desktop", "mobile_web", "total" ], "type": "string" } }, "required": [ "segment" ], "type": "object" }, "status": { "enum": [ "success", "error" ], "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "OK" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Segments Analysis", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported.", "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. The reference metric visits is documented for monthly total traffic. Sources: https://docs.similarweb.com/api-v5/api-reference/website-analysis-api/website-segments/segments and https://docs.similarweb.com/api-v5/guides/available-data" ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb_apis_v1_similarweb_segment_analysi_64e47c", "x-aisa-pricing": { "cost_contract": "plan_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.075, "estimate_source": "profile_seed", "evidence_source": "request_snapshot", "request_cost_drivers": { "formula": { "input_multiplier": 1, "inputs": [ "metrics", "periods" ] }, "inputs": [ { "field": { "selector": "metrics", "source": "query" }, "kind": "array_length", "name": "metrics" }, { "allowed_granularities": [ "monthly" ], "end": { "selector": "end_date", "source": "query" }, "granularity": { "selector": "granularity", "source": "query" }, "kind": "calendar_buckets", "max": 12, "min": 1, "name": "periods", "start": { "selector": "start_date", "source": "query" } } ], "kind": "plan_units" }, "unit": "similarweb_credit", "unit_rate_usd": 0.075 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:f10975f9c9724503e3360200a917adc6ae54dcc63be15e795e48a858773eda36", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:3e6530c8ac49584e4a722c0a6eed6508eecd748e841953f052377982ed9482da", "converter": "scripts/import_similarweb_response_reference.py@2", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "limits": [ "UI value fields are example values, not defaults. Named array children and differing prototypes fail closed." ], "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:15149a3f9ba4c99eb226f1cd30d98679b3c2ba2f3434d960445e910bc081d297", "refresh_policy": "manual", "refresh_reason": "Official typed response snapshot and deployment transport binding require explicit manual review.", "response_only": true, "review_period_days": 30, "source_pages": [ { "raw_content_hash": "sha256:635ba8e2eff2da968f990c56ac6a0ac49f0a2030ab47f1f6540df51703b53722", "url": "https://docs.similarweb.com/api-v5/similarweb-api/website-analysis-api/website-segments/segments" } ], "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "05b7216bd5a7807ba07be0367959de70792e108b6c285064a3877c63c6a3136f", "url": "https://docs.similarweb.com/api-v5/similarweb-api/website-analysis-api/website-segments/segments" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "05b7216bd5a7807ba07be0367959de70792e108b6c285064a3877c63c6a3136f", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "823fb2e07fec" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_apis_v1_similarweb_segment_analysi_64e47c", "path": "/apis/v1/similarweb/segment-analysis/segments/traffic-and-engagement" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/segment-analysis/segments/traffic-and-engagement?country=ww&end_date=2026-09&granularity=monthly&metrics=visits&segment=YOUR_SEGMENT_ID&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/segment-analysis/segments/traffic-sources": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.075 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_apis_v1_similarweb_segment_analysi_6349fe", "parameters": [ { "examples": { "default": { "value": "ww" }, "minimal": { "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": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "format", "required": false, "schema": { "enum": [ "json" ], "type": "string" } }, { "examples": { "default": { "value": "monthly" }, "minimal": { "value": "monthly" } }, "in": "query", "name": "granularity", "required": true, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "examples": { "default": { "value": "visits" }, "minimal": { "value": "visits" } }, "in": "query", "name": "metrics", "required": true, "schema": { "type": "string", "x-aisa-delimiter": ",", "x-aisa-maxItems": 8, "x-aisa-minItems": 1 } }, { "examples": { "default": { "value": "YOUR_SEGMENT_ID" }, "minimal": { "value": "YOUR_SEGMENT_ID" } }, "in": "query", "name": "segment", "required": true, "schema": { "description": "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.", "maxLength": 2048, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "total" ], "type": "string" } } ], "responses": { "200": { "description": "成功响应" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Segments Marketing Channels", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported.", "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. The reference metric visits is documented for monthly total traffic. Sources: https://docs.similarweb.com/api-v5/api-reference/website-analysis-api/website-segments/segments-marketing-channels and https://docs.similarweb.com/api-v5/guides/available-data" ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb_apis_v1_similarweb_segment_analysi_6349fe", "x-aisa-pricing": { "cost_contract": "plan_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.075, "estimate_source": "profile_seed", "evidence_source": "request_snapshot", "request_cost_drivers": { "formula": { "input_multiplier": 1, "inputs": [ "metrics", "periods" ] }, "inputs": [ { "field": { "selector": "metrics", "source": "query" }, "kind": "array_length", "name": "metrics" }, { "allowed_granularities": [ "monthly" ], "end": { "selector": "end_date", "source": "query" }, "granularity": { "selector": "granularity", "source": "query" }, "kind": "calendar_buckets", "max": 12, "min": 1, "name": "periods", "start": { "selector": "start_date", "source": "query" } } ], "kind": "plan_units" }, "unit": "similarweb_credit", "unit_rate_usd": 0.075 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-pending": { "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" ] }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "19fe562a9089a7e0db16d5f7fde0dabec7abb4abf0000d17dd38cf941230e333", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "42c2aed8a132" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_apis_v1_similarweb_segment_analysi_6349fe", "path": "/apis/v1/similarweb/segment-analysis/segments/traffic-sources" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/segment-analysis/segments/traffic-sources?country=ww&end_date=2026-09&granularity=monthly&metrics=visits&segment=YOUR_SEGMENT_ID&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website-analysis/websites/conversion-rates": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.375 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_apis_v1_similarweb_website_analysi_850464", "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": { "maxLength": 2048, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "format", "required": false, "schema": { "enum": [ "json" ], "type": "string" } }, { "examples": { "default": { "value": "monthly" }, "minimal": { "value": "monthly" } }, "in": "query", "name": "granularity", "required": true, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "total" ], "type": "string" } } ], "responses": { "200": { "description": "成功响应" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Conversion Rates Over Time", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb_apis_v1_similarweb_website_analysi_850464", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.375, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 20, "reserve_plan_units": { "input": "limit", "input_multiplier": 5 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "units_per_count": 5 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-pending": { "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" ] }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "1e0aba163f851b1307ba4b60ddd66e4166055bf701f70233298bc377c7b2d225", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "84ccc9815c6c" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_apis_v1_similarweb_website_analysi_850464", "path": "/apis/v1/similarweb/website-analysis/websites/conversion-rates" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website-analysis/websites/conversion-rates?country=ww&domain=example.com&end_date=2026-09&granularity=monthly&limit=1&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website-analysis/websites/conversion-rates/aggregated": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.375 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_apis_v1_similarweb_website_analysi_7399a9", "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": { "maxLength": 2048, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "format", "required": false, "schema": { "enum": [ "json" ], "type": "string" } }, { "examples": { "default": { "value": "monthly" }, "minimal": { "value": "monthly" } }, "in": "query", "name": "granularity", "required": true, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "total" ], "type": "string" } } ], "responses": { "200": { "description": "成功响应" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Conversion Rates Aggregated", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb_apis_v1_similarweb_website_analysi_7399a9", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.375, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 20, "reserve_plan_units": { "input": "limit", "input_multiplier": 5 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "units_per_count": 5 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-pending": { "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" ] }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "a0051c200c71f1719f20aba95466794d61f03140f8525a0fd049158787c64c7a", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "2ce12af2c0f8" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_apis_v1_similarweb_website_analysi_7399a9", "path": "/apis/v1/similarweb/website-analysis/websites/conversion-rates/aggregated" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website-analysis/websites/conversion-rates/aggregated?country=ww&domain=example.com&end_date=2026-09&granularity=monthly&limit=1&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website-analysis/websites/traffic-by-demographics/aggregated": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.45 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_apis_v1_similarweb_website_analysi_aa2e1f", "parameters": [ { "examples": { "default": { "value": "18" }, "minimal": { "value": "18" } }, "in": "query", "name": "age_bucket", "required": true, "schema": { "description": "Select one age bucket; age_bucket must be provided exactly once.", "enum": [ "18", "25", "35", "45", "55", "65" ], "type": "string" } }, { "examples": { "default": { "value": "ww" }, "minimal": { "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": "cnn.com" }, "minimal": { "value": "cnn.com" } }, "in": "query", "name": "domain", "required": true, "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "format", "required": false, "schema": { "enum": [ "json" ], "type": "string" } }, { "examples": { "default": { "value": "monthly" }, "minimal": { "value": "monthly" } }, "in": "query", "name": "granularity", "required": true, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "examples": { "default": { "value": "share" }, "minimal": { "value": "share" } }, "in": "query", "name": "metrics", "required": true, "schema": { "description": "The reference example uses the documented v5 metric share. Metric values are comma-separated.", "type": "string", "x-aisa-delimiter": ",", "x-aisa-maxItems": 8, "x-aisa-minItems": 1 } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "total" ], "type": "string" } } ], "responses": { "200": { "description": "成功响应" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Demographics - Specific Groups", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported.", "Select one age bucket; age_bucket must be provided exactly once.", "The reference example uses the documented v5 metric share. Metric values are comma-separated. Source: https://docs.similarweb.com/api-v5/api-reference/website-analysis-api/website-audience/demographics-specific-groups" ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb_apis_v1_similarweb_website_analysi_aa2e1f", "x-aisa-pricing": { "cost_contract": "plan_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.45, "estimate_source": "profile_seed", "evidence_source": "request_snapshot", "request_cost_drivers": { "formula": { "input_multiplier": 6, "inputs": [ "metrics", "periods" ] }, "inputs": [ { "field": { "selector": "metrics", "source": "query" }, "kind": "array_length", "name": "metrics" }, { "allowed_granularities": [ "monthly" ], "end": { "selector": "end_date", "source": "query" }, "granularity": { "selector": "granularity", "source": "query" }, "kind": "calendar_buckets", "max": 1, "min": 1, "name": "periods", "start": { "selector": "start_date", "source": "query" } } ], "kind": "plan_units" }, "unit": "similarweb_credit", "unit_rate_usd": 0.075 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-pending": { "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" ] }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "f8cfc8beb5321847f7f5907ac43d5a15fe1d2860bbe67c48d826bd0498afb83b", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "64a2b0489a86" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_apis_v1_similarweb_website_analysi_aa2e1f", "path": "/apis/v1/similarweb/website-analysis/websites/traffic-by-demographics/aggregated" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website-analysis/websites/traffic-by-demographics/aggregated?age_bucket=18&country=ww&domain=cnn.com&end_date=2026-09&granularity=monthly&metrics=share&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website-top-geographies": { "get": { "description": "\n按用量计费；默认请求预估费用：$2.25 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_website_top_geographies", "parameters": [ { "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": { "countries": { "items": { "additionalProperties": false, "properties": { "country_code": { "type": "string" }, "country_name": { "type": "string" }, "rank": { "type": [ "number", "null" ] }, "share": { "type": [ "number", "null" ] }, "visits": { "type": [ "number", "null" ] } }, "required": [ "country_code", "country_name", "rank", "share", "visits" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "countries" ], "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" } }, "summary": "Website Top Geographies", "tags": [ "website" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "similarweb", "x-aisa-constraints": { "notes": [ "Worldwide data only; country is fixed to ww and cannot be supplied.", "Monthly granularity only.", "Total web source and main domain only.", "The result limit is fixed at 10 and cannot be overridden.", "Provider usage grows with actual returned country rows, capped at 10." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-top-geographies", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 2.25, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 10, "reserve_plan_units": { "input": "limit", "input_multiplier": 3 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "units_per_count": 3 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": false, "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "fc9d44eb61a8" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_website_top_geographies", "path": "/apis/v1/similarweb/website-top-geographies" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website-top-geographies?domain=example.com&month=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website-traffic-snapshot": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.3 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "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" } }, "summary": "Website Traffic Snapshot", "tags": [ "website" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "similarweb", "x-aisa-constraints": { "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." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-traffic-snapshot", "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 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": false, "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "993278563bd0" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_website_traffic_snapshot", "path": "/apis/v1/similarweb/website-traffic-snapshot" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website-traffic-snapshot?country=ww&domain=example.com&month=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website-traffic-trend": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.45 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_website_traffic_trend", "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" } }, { "in": "query", "name": "end_date", "required": false, "schema": { "description": "Inclusive last complete UTC month in YYYY-MM.", "type": "string" } }, { "examples": { "default": { "value": "visits" } }, "in": "query", "name": "metrics", "required": false, "schema": { "default": "visits", "description": "One to four supported Traffic & Engagement metrics.", "type": "string", "x-aisa-delimiter": ",", "x-aisa-item-enum": [ "average_visit_duration", "bounce_rate", "new_users", "page_views", "pages_per_visit", "returning_users", "unique_visitors", "visits" ], "x-aisa-maxItems": 4 } }, { "in": "query", "name": "start_date", "required": false, "schema": { "description": "Inclusive first month in YYYY-MM; provide together with end_date.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "domain": { "type": "string" }, "metrics": { "items": { "enum": [ "average_visit_duration", "bounce_rate", "new_users", "page_views", "pages_per_visit", "returning_users", "unique_visitors", "visits" ], "type": "string" }, "maxItems": 4, "minItems": 1, "type": "array", "uniqueItems": true }, "points": { "items": { "additionalProperties": false, "properties": { "month": { "pattern": "^[0-9]{4}-[0-9]{2}$", "type": "string" }, "values": { "additionalProperties": false, "properties": { "average_visit_duration": { "type": [ "number", "null" ] }, "bounce_rate": { "type": [ "number", "null" ] }, "new_users": { "type": [ "number", "null" ] }, "page_views": { "type": [ "number", "null" ] }, "pages_per_visit": { "type": [ "number", "null" ] }, "returning_users": { "type": [ "number", "null" ] }, "unique_visitors": { "type": [ "number", "null" ] }, "visits": { "type": [ "number", "null" ] } }, "type": "object" } }, "required": [ "month", "values" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "domain", "metrics", "points" ], "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" } }, "summary": "Website Traffic Trend", "tags": [ "website" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "similarweb", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww.", "Monthly granularity only.", "Total web source and main domain only.", "Defaults to the latest six complete UTC months; maximum range is 12 months.", "Provider usage grows with inclusive months multiplied by unique requested metrics." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-traffic-trend", "x-aisa-pricing": { "cost_contract": "plan_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.45, "estimate_source": "profile_seed", "evidence_source": "request_snapshot", "unit": "similarweb_credit", "unit_rate_usd": 0.075 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": false, "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "3f0c9e8db982" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_website_traffic_trend", "path": "/apis/v1/similarweb/website-traffic-trend" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website-traffic-trend?country=ww&domain=example.com&metrics=visits' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website/ad-networks": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.225 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_ad_networks", "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": { "maxLength": 253, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "required": false, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "offset", "required": false, "schema": { "maximum": 100000, "minimum": 0, "type": "integer" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "traffic_source", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "desktop", "mobile_web", "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "ad_network": { "type": "string" }, "change": { "type": "number" }, "share": { "type": "number" } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/ResponseFd1670723A17_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Ad Networks", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-ad-networks", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.225, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 20, "reserve_plan_units": { "input": "limit", "input_multiplier": 3 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "units_per_count": 3 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:e19134f11434af9089ec8261ed0afe1079f7ea663c5ee70de76ab310d0fe8244", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:a1763d851c0982f5692cf5232a47602bc4c93b8d65b23bb8096e9f64917c0ef3", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:16d0e6d0cb04e68c2a48316fa9a02a5c457053c707931f39c3ac81bf86df4d7e", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "ec279b630b09dbed42b7d788ead87b349d8e3e07d10512afd2e502741a02beee", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "ec279b630b09dbed42b7d788ead87b349d8e3e07d10512afd2e502741a02beee", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "ec279b630b09dbed42b7d788ead87b349d8e3e07d10512afd2e502741a02beee", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "6ee774477d80" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_ad_networks", "path": "/apis/v1/similarweb/website/ad-networks" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website/ad-networks?country=ww&domain=example.com&end_date=2026-09&limit=1&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website/audience-interest": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.375 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_audience_interest", "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": { "maxLength": 253, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "required": false, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "offset", "required": false, "schema": { "maximum": 100000, "minimum": 0, "type": "integer" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "traffic_source", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "desktop", "mobile_web", "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "affinity": { "description": "Similarity score between the analyzed website and the related domain", "format": "double", "type": [ "number", "null" ] }, "domain": { "description": "Related website frequently visited by the same audience as the analyzed site", "type": [ "string", "null" ] }, "has_adsense": { "description": "Indicates whether the related domain runs Google AdSense", "type": [ "boolean", "null" ] }, "overlap": { "description": "Percentage of visitors shared between the analyzed website and the related domain", "format": "double", "type": [ "number", "null" ] }, "pop_change": { "description": "Monthly change in overlap percentage points", "format": "double", "type": [ "number", "null" ] } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/Response876D22944B7A_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Audience Interest", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-audience-interest", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.375, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 20, "reserve_plan_units": { "input": "limit", "input_multiplier": 5 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "units_per_count": 5 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:89ed23dbc52c6f351beebad900bf23282b8af20945ae865845dd66ff31acf3ef", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:7b30c2567ea96c60aa91e9779e9592d48ece4ffc76d2acbd49e6847bf72d8d84", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:035f526ae75de2daf67666bb34beed20ff974757e8a4fdebec708629be08d748", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "d55239e48c8194a7917206508d0a29e7a59821f959a61f6b556cb0262455d0e0", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_contract_review": { "authority_url": "https://docs.similarweb.com/api-v5/api-reference/website-analysis-api/website-audience/audience-interest", "changes": [ { "after": { "description": "Related website frequently visited by the same audience as the analyzed site", "type": [ "string", "null" ] }, "before": { "type": "string" }, "field": "data[].domain", "official_declaration": { "_id": "69bb2a7905dec287fa2ffd4c", "complexItems": [], "description": "Related website frequently visited by the same audience as the analyzed site", "isRequired": false, "items": [], "name": "domain", "options": { "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "string" } }, { "after": { "description": "Similarity score between the analyzed website and the related domain", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].affinity", "official_declaration": { "_id": "69bb2a7905dec287fa2ffd4d", "complexItems": [], "description": "Similarity score between the analyzed website and the related domain", "isRequired": false, "items": [], "name": "affinity", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "number" } }, { "after": { "description": "Percentage of visitors shared between the analyzed website and the related domain", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].overlap", "official_declaration": { "_id": "69bb2a7905dec287fa2ffd4e", "complexItems": [], "description": "Percentage of visitors shared between the analyzed website and the related domain", "isRequired": false, "items": [], "name": "overlap", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "number" } }, { "after": { "description": "Indicates whether the related domain runs Google AdSense", "type": [ "boolean", "null" ] }, "before": { "type": "boolean" }, "field": "data[].has_adsense", "official_declaration": { "_id": "69bb2a7905dec287fa2ffd4f", "complexItems": [], "description": "Indicates whether the related domain runs Google AdSense", "isRequired": false, "items": [], "name": "has_adsense", "options": { "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "boolean" } }, { "after": { "description": "Monthly change in overlap percentage points", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].pop_change", "official_declaration": { "_id": "69bb2a7905dec287fa2ffd50", "complexItems": [], "description": "Monthly change in overlap percentage points", "isRequired": false, "items": [], "name": "pop_change", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "number" } } ], "file": "openapi/upstream/response-similarweb-get-a96bf1af1159f485.json", "public_path": "/apis/v1/similarweb/website/audience-interest", "raw_content_hash": "sha256:33af897af89ade082135ba95c755fd4604c0c60b9431abd4ebfd3b1a66fd0874", "unresolved": [], "upstream_path": "/v5/website-analysis/websites/audience-interests/aggregated" }, "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "d55239e48c8194a7917206508d0a29e7a59821f959a61f6b556cb0262455d0e0", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "d55239e48c8194a7917206508d0a29e7a59821f959a61f6b556cb0262455d0e0", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "559f9719b593" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_audience_interest", "path": "/apis/v1/similarweb/website/audience-interest" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website/audience-interest?country=ww&domain=example.com&end_date=2026-09&limit=1&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website/audience-overlap": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.75 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_audience_overlap", "parameters": [ { "examples": { "default": { "value": "ww" }, "minimal": { "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": "cnn.com,bbc.com" }, "minimal": { "value": "cnn.com,bbc.com" } }, "in": "query", "name": "domains", "required": true, "schema": { "type": "string", "x-aisa-delimiter": ",", "x-aisa-maxItems": 5, "x-aisa-minItems": 2 } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "required": false, "schema": { "default": "monthly", "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "domains": { "type": "string" }, "overlap_unique_visitors": { "type": "number" }, "union_unique_users": { "type": "number" } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/Response3716D452B70B_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Audience Overlap", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-audience-overlap", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.75, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 5, "reserve_plan_units": { "fixed_units": 10 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "units_per_count": 2 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:f292ff665c5381ff2e9a50ac21dc7b3438639f0c2210e5bce348215e75687453", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:4936b468201225b90239d16e7a78e1af3001ab494b9aa7b2e7116155290c16d5", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:0b7f0580be31df2ea6b7aa17427707819b99b0dc15c1a9cc4404d87b00e2b374", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "f27e7d359dd5e1251188355055e96effcedebcdbc2da344673925c77d492b543", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "f27e7d359dd5e1251188355055e96effcedebcdbc2da344673925c77d492b543", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "f27e7d359dd5e1251188355055e96effcedebcdbc2da344673925c77d492b543", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "b673b4e77fd6" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_audience_overlap", "path": "/apis/v1/similarweb/website/audience-overlap" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website/audience-overlap?country=ww&domains=cnn.com%2Cbbc.com&end_date=2026-09&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website/deduplicated-audience": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.525 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_deduplicated_audience", "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": { "maxLength": 253, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "examples": { "default": { "value": "monthly" } }, "in": "query", "name": "granularity", "required": false, "schema": { "default": "monthly", "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": true } }, "in": "query", "name": "main_domain_only", "required": false, "schema": { "default": true, "type": "boolean" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "desktop", "mobile_web", "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "date": { "type": "string" }, "desktop_and_mobile_web_audience_share": { "type": "number" }, "desktop_and_mobile_web_audience_visitors": { "type": "number" }, "desktop_only_audience_share": { "type": "number" }, "desktop_only_audience_visitors": { "type": "number" }, "mobile_web_only_audience_share": { "type": "number" }, "mobile_web_only_audience_visitors": { "type": "number" }, "total_deduplicated_audience": { "type": "number" } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/Response9E9628F8A247_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Deduplicated Audience", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-deduplicated-audience", "x-aisa-pricing": { "cost_contract": "plan_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.525, "estimate_source": "profile_seed", "evidence_source": "request_snapshot", "request_cost_drivers": { "formula": { "input": "periods", "input_multiplier": 7 }, "inputs": [ { "allowed_granularities": [ "monthly" ], "default_buckets": { "monthly": 12 }, "end": { "selector": "end_date", "source": "query" }, "granularity": { "selector": "granularity", "source": "query" }, "kind": "calendar_buckets", "max": 120, "min": 1, "name": "periods", "start": { "selector": "start_date", "source": "query" } } ], "kind": "plan_units" }, "unit": "similarweb_credit", "unit_rate_usd": 0.075 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:2cddf3726104307585bdb6156657dbb34c7f3df68c4c498ccf47778652405ba2", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:cc05b23b6ed4362e899bbe4ec05819cdde64d5e2def72f6dbe2b8f1dbb1da499", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:45af9725297ea1de65e315fff9e9aafc1716df6ea03d7fb66ade9ccb1314ccf4", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "4642c81eb5c77a7031f1813dafbdafa62dd1dce53ae3abd795b8a9c6401f7148", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "4642c81eb5c77a7031f1813dafbdafa62dd1dce53ae3abd795b8a9c6401f7148", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "4642c81eb5c77a7031f1813dafbdafa62dd1dce53ae3abd795b8a9c6401f7148", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "c4b88b1fdf0a" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_deduplicated_audience", "path": "/apis/v1/similarweb/website/deduplicated-audience" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website/deduplicated-audience?country=ww&domain=example.com&end_date=2026-09&granularity=monthly&main_domain_only=true&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website/demographics": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.6 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_demographics", "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": { "maxLength": 2048, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "format", "required": false, "schema": { "enum": [ "json" ], "type": "string" } }, { "examples": { "default": { "value": "monthly" }, "minimal": { "value": "monthly" } }, "in": "query", "name": "granularity", "required": true, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "age_18_to_24_share": { "type": "number" }, "age_25_to_34_share": { "type": "number" }, "age_35_to_44_share": { "type": "number" }, "age_45_to_54_share": { "type": "number" }, "age_55_to_64_share": { "type": "number" }, "age_65_plus_share": { "type": "number" }, "female_share": { "type": "number" }, "male_share": { "type": "number" } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/Response87Ff1885565E_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Demographics", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-demographics", "x-aisa-pricing": { "cost_contract": "plan_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.6, "estimate_source": "profile_seed", "evidence_source": "request_snapshot", "request_cost_drivers": { "formula": { "fixed_units": 8 }, "inputs": [], "kind": "plan_units" }, "unit": "similarweb_credit", "unit_rate_usd": 0.075 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:49c64a90fb827f4df95b339f9cf50ddcb5386b053e0abb1f75b2d90660a2eb13", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:9e6ee57f5c1fad041b88057d40ebd0d2c150f30ee9a8561abe3cf8a24172bb77", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:7e89298e8eb24f53764118e235b13457dc0c4ea6dca65a43c86db6947a3f95af", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "67963922601dcfa42d6194e8a6631e7434ac52588e4facc9c6c0c74da36dd3a0", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "67963922601dcfa42d6194e8a6631e7434ac52588e4facc9c6c0c74da36dd3a0", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "67963922601dcfa42d6194e8a6631e7434ac52588e4facc9c6c0c74da36dd3a0", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "8619d120c8b4" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_demographics", "path": "/apis/v1/similarweb/website/demographics" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website/demographics?country=ww&domain=example.com&end_date=2026-09&granularity=monthly&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website/folders": { "get": { "description": "{\"methods\":[{\"methodType\":\"GET\",\"methodDesc\":\"Returns a list of leading folders for a domain and share per folder\",\"requestParams\":[{\"name\":\"domain\",\"type\":\"string\",\"required\":true,\"paramType\":\"query\",\"desc\":\"Website domain without 'www.' (e.g., 'example.com')\"},{\"name\":\"start_date\",\"type\":\"string\",\"required\":false,\"paramType\":\"query\",\"desc\":\"Start date in 'YYYY-MM' or 'YYYY-MM-DD' format\"},{\"name\":\"end_date\",\"type\":\"string\",\"required\":false,\"paramType\":\"query\",\"desc\":\"End date in 'YYYY-MM' or 'YYYY-MM-DD' format\"},{\"name\":\"granularity\",\"type\":\"string\",\"required\":false,\"paramType\":\"query\",\"desc\":\"Time granularity\"},{\"name\":\"web_source\",\"type\":\"string\",\"required\":false,\"paramType\":\"query\",\"desc\":\"Specifies the web source device type\"},{\"name\":\"country\",\"type\":\"string\",\"required\":false,\"paramType\":\"query\",\"desc\":\"Two-letter country code (e.g., 'us', 'gb', 'ww')\"},{\"name\":\"main_domain_only\",\"type\":\"boolean\",\"required\":false,\"paramType\":\"query\",\"desc\":\"'true' to include only the main domain, 'false' to include subdomains. Defaul...\"},{\"name\":\"format\",\"type\":\"string\",\"required\":false,\"paramType\":\"query\",\"desc\":\"Format in which the reply should be returned.\"},{\"name\":\"limit\",\"type\":\"integer\",\"required\":false,\"paramType\":\"query\",\"desc\":\"Number of items per page for pagination, default is 100\"},{\"name\":\"offset\",\"type\":\"integer\",\"required\":false,\"paramType\":\"query\",\"desc\":\"Page number for pagination, starting from 1\"},{\"name\":\"asc\",\"type\":\"boolean\",\"required\":false,\"paramType\":\"query\",\"desc\":\"Sort order direction, 'true' for ascending, 'false' for descending. Default i...\"},{\"name\":\"sort\",\"type\":\"string\",\"required\":false,\"paramType\":\"query\",\"desc\":\"Sort order for the results, applied on the properties of the returned record\"},{\"name\":\"api-key\",\"type\":\"string\",\"required\":false,\"paramType\":\"header\",\"desc\":\"\"}],\"responseParams\":[{\"name\":\"meta\",\"type\":\"object\",\"desc\":\"\"},{\"name\":\"data\",\"type\":\"array\",\"desc\":\"\"}]}]}\n\n\n按用量计费；默认请求预估费用：$0.3 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "similarwebFolders", "parameters": [ { "examples": { "default": { "value": "ww" }, "minimal": { "value": "ww" } }, "in": "query", "name": "country", "required": true, "schema": { "enum": [ "ww" ], "type": "string" } }, { "examples": { "default": { "value": "example.com" }, "minimal": { "value": "example.com" } }, "in": "query", "name": "domain", "required": true, "schema": { "maxLength": 2048, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "format", "required": false, "schema": { "enum": [ "json" ], "type": "string" } }, { "examples": { "default": { "value": "monthly" }, "minimal": { "value": "monthly" } }, "in": "query", "name": "granularity", "required": true, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "total" ], "type": "string" } } ], "responses": { "200": { "description": "成功响应" }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Website Folders", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/similarwebFolders", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.333333, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.3, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 20, "reserve_plan_units": { "input": "limit", "input_multiplier": 3 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "units_per_count": 3 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-pending": { "method": "GET", "operation_id": "similarwebFolders", "path": "/apis/v1/similarweb/website/folders", "reason": "public success response has no authoritative payload declaration", "statuses": [ "200" ] }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "05eba82be1e5199bf0fa1d4a9ecabdf9b29d342fb3508e57c463f263f80e0c08", "x-aisa-revision": { "customer_pricing_ref": "2ba257f03fd0", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "220029d2abb4" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "similarwebFolders", "path": "/apis/v1/similarweb/website/folders" }, "x-aisa-status": "disabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website/folders?country=ww&domain=example.com&end_date=2026-09&granularity=monthly&limit=1&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website/marketing-channel-sources-legacy": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.525 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_marketing_channel_sources_legacy", "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": { "maxLength": 253, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "examples": { "default": { "value": "monthly" } }, "in": "query", "name": "granularity", "required": false, "schema": { "default": "monthly", "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": true } }, "in": "query", "name": "main_domain_only", "required": false, "schema": { "default": true, "type": "boolean" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "desktop", "mobile_web", "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "average_visit_duration": { "description": "Average time on website (in seconds)", "format": "double", "type": [ "number", "null" ] }, "bounce_rate": { "description": "Percentage of visits that view only one page on the website", "format": "double", "type": [ "number", "null" ] }, "date": { "type": "string" }, "pages_per_visit": { "description": "Average number of pages viewed per visit", "format": "double", "type": [ "number", "null" ] }, "source_type": { "type": [ "string", "null" ] }, "visits": { "description": "Estimated number of visits to the website", "format": "double", "type": [ "number", "null" ] } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/Response80775Eb82C8B_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Marketing Channel Sources", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-marketing-channel-sources-legacy", "x-aisa-pricing": { "cost_contract": "plan_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.525, "estimate_source": "profile_seed", "evidence_source": "request_snapshot", "request_cost_drivers": { "formula": { "input": "periods", "input_multiplier": 7 }, "inputs": [ { "allowed_granularities": [ "monthly" ], "default_buckets": { "monthly": 12 }, "end": { "selector": "end_date", "source": "query" }, "granularity": { "selector": "granularity", "source": "query" }, "kind": "calendar_buckets", "max": 120, "min": 1, "name": "periods", "start": { "selector": "start_date", "source": "query" } } ], "kind": "plan_units" }, "unit": "similarweb_credit", "unit_rate_usd": 0.075 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:8e14f55572e40def3d59a35348e13d8b3ccbe611320447049dcd8e39468f6931", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:8dc52c9f5d68ba2519ad1ab7415fa0881d6da695242586ccaa3e1cbc1934c136", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:f61f708e6ecc5038c36997af4917759793bf0a588ccf195a83372e3514e9ed67", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "2c8a81b086ab5e098aacdcd2ef2f4707f67282f770289a2e8599c70a29425bd3", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_contract_review": { "authority_url": "https://docs.similarweb.com/api-v5/api-reference/website-analysis-api/marketing-channels/marketing-channel-sources-old", "changes": [ { "after": { "type": [ "string", "null" ] }, "before": { "type": "string" }, "field": "data[].source_type", "official_declaration": { "_id": "6a4c0a43685bdf015002f33b", "complexItems": [], "description": "", "isRequired": false, "items": [], "name": "source_type", "options": { "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "Direct", "valueType": "string" } }, { "after": { "description": "Estimated number of visits to the website", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].visits", "official_declaration": { "_id": "6a4c0a43685bdf015002f33c", "complexItems": [], "description": "Estimated number of visits to the website", "isRequired": false, "items": [], "name": "visits", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "697602048.9416921", "valueType": "number" } }, { "after": { "description": "Percentage of visits that view only one page on the website", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "string" }, "field": "data[].bounce_rate", "official_declaration": { "_id": "6a4c0a43685bdf015002f33d", "complexItems": [], "description": "Percentage of visits that view only one page on the website", "isRequired": false, "items": [], "name": "bounce_rate", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "number" } }, { "after": { "description": "Average time on website (in seconds)", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "string" }, "field": "data[].average_visit_duration", "official_declaration": { "_id": "6a4c0a43685bdf015002f33e", "complexItems": [], "description": "Average time on website (in seconds)", "isRequired": false, "items": [], "name": "average_visit_duration", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "number" } }, { "after": { "description": "Average number of pages viewed per visit", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "string" }, "field": "data[].pages_per_visit", "official_declaration": { "_id": "6a4c0a43685bdf015002f33f", "complexItems": [], "description": "Average number of pages viewed per visit", "isRequired": false, "items": [], "name": "pages_per_visit", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "", "valueType": "number" } } ], "file": "openapi/upstream/response-similarweb-get-0e0c37d07d52cc73.json", "public_path": "/apis/v1/similarweb/website/marketing-channel-sources-legacy", "raw_content_hash": "sha256:f56b8f7a99b5b417d9abc0c7f2e0ea4b910026ed593f47c5baa3e482854f36c7", "unresolved": [], "upstream_path": "/v5/website-analysis/websites/traffic-sources" }, "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "2c8a81b086ab5e098aacdcd2ef2f4707f67282f770289a2e8599c70a29425bd3", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "2c8a81b086ab5e098aacdcd2ef2f4707f67282f770289a2e8599c70a29425bd3", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "e283a6d300b5" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_marketing_channel_sources_legacy", "path": "/apis/v1/similarweb/website/marketing-channel-sources-legacy" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website/marketing-channel-sources-legacy?country=ww&domain=example.com&end_date=2026-09&granularity=monthly&main_domain_only=true&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website/popular-pages": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.225 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_popular_pages", "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": { "maxLength": 253, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "required": false, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "offset", "required": false, "schema": { "maximum": 100000, "minimum": 0, "type": "integer" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "traffic_source", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "desktop", "mobile_web", "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "change": { "type": "number" }, "page": { "type": "string" }, "share": { "type": "number" } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/Response73D081Cabc11_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Popular Pages", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-popular-pages", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.225, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 20, "reserve_plan_units": { "input": "limit", "input_multiplier": 3 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "units_per_count": 3 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:9c9dde997bd7894eaffaa34146aa12ba4ba65e07376a4b83294f4dd061a194ff", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:f01263d0892fc5b88d312dedca0c65f4ef4b56831da515905a9857854ba6d8e7", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:fb1b574d387a3529d96b41d6cb4726dec037be29a53750a6c1a8b15606a5c00c", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "820f43dc2017e7459d2f0ee62f414767c5f151cc9b5523be7dbaf7c5dc604e68", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "820f43dc2017e7459d2f0ee62f414767c5f151cc9b5523be7dbaf7c5dc604e68", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "820f43dc2017e7459d2f0ee62f414767c5f151cc9b5523be7dbaf7c5dc604e68", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "038dd3ec76a8" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_popular_pages", "path": "/apis/v1/similarweb/website/popular-pages" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website/popular-pages?country=ww&domain=example.com&end_date=2026-09&limit=1&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website/ppc-spend": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.075 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_ppc_spend", "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": { "maxLength": 253, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "examples": { "default": { "value": "monthly" } }, "in": "query", "name": "granularity", "required": false, "schema": { "default": "monthly", "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": true } }, "in": "query", "name": "main_domain_only", "required": false, "schema": { "default": true, "type": "boolean" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "desktop", "mobile_web", "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "currency": { "type": "string" }, "date": { "type": "string" }, "ppc_spend": { "type": "number" } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/Response0Cee89220B8F_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "PPC Spend", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-ppc-spend", "x-aisa-pricing": { "cost_contract": "plan_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.075, "estimate_source": "profile_seed", "evidence_source": "request_snapshot", "request_cost_drivers": { "formula": { "input": "periods", "input_multiplier": 1 }, "inputs": [ { "allowed_granularities": [ "monthly" ], "default_buckets": { "monthly": 12 }, "end": { "selector": "end_date", "source": "query" }, "granularity": { "selector": "granularity", "source": "query" }, "kind": "calendar_buckets", "max": 120, "min": 1, "name": "periods", "start": { "selector": "start_date", "source": "query" } } ], "kind": "plan_units" }, "unit": "similarweb_credit", "unit_rate_usd": 0.075 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:02cce3d226f37d45d280da99ebcb607c23502960030fbf1b02768f619805f444", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:f46f01ba80e3aad867c65ca8e35b234f80faa5832f45ff9726b806c4cecfc449", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:6f53767704129acae2ffa517643191410147b288e27c90c1b59a8ddc0ca966f3", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "0022ad1e1884788bc7dd7b248049083967ea8c5fde943d23fdf9a3e3c980e9e3", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "0022ad1e1884788bc7dd7b248049083967ea8c5fde943d23fdf9a3e3c980e9e3", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "0022ad1e1884788bc7dd7b248049083967ea8c5fde943d23fdf9a3e3c980e9e3", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "3e82d26e4b7b" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_ppc_spend", "path": "/apis/v1/similarweb/website/ppc-spend" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website/ppc-spend?country=ww&domain=example.com&end_date=2026-09&granularity=monthly&main_domain_only=true&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website/ranking": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.15 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_ranking", "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": { "maxLength": 253, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "examples": { "default": { "value": "monthly" } }, "in": "query", "name": "granularity", "required": false, "schema": { "default": "monthly", "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": true } }, "in": "query", "name": "main_domain_only", "required": false, "schema": { "default": true, "type": "boolean" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "desktop", "mobile_web", "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "category": { "type": "string" }, "category_rank": { "type": "integer" }, "country_rank": { "type": "integer" }, "date": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/ResponseA0396574Ebbb_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Website Ranking", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-ranking", "x-aisa-pricing": { "cost_contract": "plan_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.15, "estimate_source": "profile_seed", "evidence_source": "request_snapshot", "request_cost_drivers": { "formula": { "input": "periods", "input_multiplier": 2 }, "inputs": [ { "allowed_granularities": [ "monthly" ], "default_buckets": { "monthly": 12 }, "end": { "selector": "end_date", "source": "query" }, "granularity": { "selector": "granularity", "source": "query" }, "kind": "calendar_buckets", "max": 120, "min": 1, "name": "periods", "start": { "selector": "start_date", "source": "query" } } ], "kind": "plan_units" }, "unit": "similarweb_credit", "unit_rate_usd": 0.075 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:205b3b38229764dedd3633667b94529b00eebd2c4bbd090b5e09fa38c0161805", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:74c557c0192a9cfc26365881b523c363c947a9e1a20321d4fd939249aae4f40b", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:7e2dbabd46a2948ae3f7ce7f9c97b04fde9b43ea7c7419cfd3a66e639fd34219", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "72caed7570344794219b58beaf7b49ec1dbc8fae8a8f409baaaf0d684d674c35", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "72caed7570344794219b58beaf7b49ec1dbc8fae8a8f409baaaf0d684d674c35", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "72caed7570344794219b58beaf7b49ec1dbc8fae8a8f409baaaf0d684d674c35", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "6921133134e3" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_ranking", "path": "/apis/v1/similarweb/website/ranking" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website/ranking?country=ww&domain=example.com&end_date=2026-09&granularity=monthly&main_domain_only=true&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website/referrals": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.3 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_referrals", "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": { "maxLength": 253, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "required": false, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "offset", "required": false, "schema": { "maximum": 100000, "minimum": 0, "type": "integer" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "traffic_source", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "desktop", "mobile_web", "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "change": { "type": "number" }, "domain": { "type": "string" }, "share": { "type": "number" }, "visits": { "type": "number" } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/Response758Fcfa4290B_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Referrals", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-referrals", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.3, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 20, "reserve_plan_units": { "input": "limit", "input_multiplier": 4 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "units_per_count": 4 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:8e672d422da0a11d47d236ccbdaf4ef32273626b1c0107d7e1cc1d023b3c61d8", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:7619a535b22df3253e0abe04e9c2ba1434b105522d72447d0d0bae3a7e13c92d", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:789014f0a132b2e4507c4631bd79e7006c08a7459e1f027c6517e9cc885288c9", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "391d3e7a6087bbcee7aed9072b97db57cc70f305ccf0576341aa84bedf33383a", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "391d3e7a6087bbcee7aed9072b97db57cc70f305ccf0576341aa84bedf33383a", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "391d3e7a6087bbcee7aed9072b97db57cc70f305ccf0576341aa84bedf33383a", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "8658c77491d2" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_referrals", "path": "/apis/v1/similarweb/website/referrals" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website/referrals?country=ww&domain=example.com&end_date=2026-09&limit=1&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website/similar-sites": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.375 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_similar_sites", "parameters": [ { "examples": { "default": { "value": "ww" }, "minimal": { "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": "cnn.com" }, "minimal": { "value": "cnn.com" } }, "in": "query", "name": "domain", "required": true, "schema": { "maxLength": 253, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "required": false, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "offset", "required": false, "schema": { "maximum": 100000, "minimum": 0, "type": "integer" } }, { "examples": { "default": { "value": "2026-07" }, "minimal": { "value": "2026-07" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "traffic_source", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "desktop", "mobile_web", "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "affinity": 1, "category": "News_and_Media", "domain": "bbc.com", "has_adsense": true, "rank": 95 } ], "meta": { "last_updated": "2026-07-31", "query": { "asc": null, "limit": 5, "offset": 0, "sort": null }, "request": { "category": null, "domain": "cnn.com", "end_date": "2026-07-31", "format": "json", "granularity": "monthly", "metrics": [ "rank", "affinity", "has_adsense" ], "start_date": "2026-05-01" }, "status": "success" } }, "schema": { "properties": { "data": { "items": { "properties": { "affinity": { "type": "number" }, "category": { "type": "string" }, "domain": { "type": "string" }, "has_adsense": { "type": "boolean" }, "rank": { "type": "integer" } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/Response7B51F63Afd06_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "SimilarSites", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported.", "The bound Similarweb v5 upstream documents monthly granularity and the latest three months only. Use the latest available three-month interval; the reference dates are a template, not a guarantee of account data availability. Source: https://docs.similarweb.com/api-v5/api-reference/website-analysis-api/website-performance/similar-sites" ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-similar-sites", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.375, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 20, "reserve_plan_units": { "input": "limit", "input_multiplier": 5 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "units_per_count": 5 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:d8777247a2f6537770362bdbb1ac3b5a3b23b3643af263aa0e39c80cfdcf4f27", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:a0f9d29208418013b23e6a0a513c8c61d2c210518c0fc938dc06ea5b7fb7e0fa", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "ade5a8fb308735894d5a8bea36444361969ff1cfc081a36ae0c2431a0553c75f", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "ade5a8fb308735894d5a8bea36444361969ff1cfc081a36ae0c2431a0553c75f", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "c1ed2e0601ad" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_similar_sites", "path": "/apis/v1/similarweb/website/similar-sites" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website/similar-sites?country=ww&domain=cnn.com&end_date=2026-09&limit=1&start_date=2026-07' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website/subdomains": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.15 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_subdomains", "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": { "maxLength": 253, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "required": false, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "offset", "required": false, "schema": { "maximum": 100000, "minimum": 0, "type": "integer" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "traffic_source", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "desktop", "mobile_web", "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "share": { "type": "number" }, "subdomain": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/Response9A183Fe05Eb8_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Website Subdomains", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-subdomains", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.15, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 20, "reserve_plan_units": { "input": "limit", "input_multiplier": 2 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075, "units_per_count": 2 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:f905c4675c89fb031506ccf3daebe22e3629d3298f31311bf8e3f4e76fb95cc2", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:4e2344ce34d5e57d6cd8a58628fb7aaa7d2e49dcaf2ac14f73f7304254ff856a", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:824fa79a9bfe85fb90ed6bc721e0b997e9e56033e4d5985f78fb41fb10badeb0", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "05979a85ed8314cd2231cba830e4362e0c75ed96cf8f1bfcf9d7e00909fccffb", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "05979a85ed8314cd2231cba830e4362e0c75ed96cf8f1bfcf9d7e00909fccffb", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "05979a85ed8314cd2231cba830e4362e0c75ed96cf8f1bfcf9d7e00909fccffb", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "4fba3188dd47" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_subdomains", "path": "/apis/v1/similarweb/website/subdomains" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website/subdomains?country=ww&domain=example.com&end_date=2026-09&limit=1&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website/technologies": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.75 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_technologies", "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": { "maxLength": 2048, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "format", "required": false, "schema": { "enum": [ "json" ], "type": "string" } }, { "examples": { "default": { "value": "monthly" }, "minimal": { "value": "monthly" } }, "in": "query", "name": "granularity", "required": true, "schema": { "enum": [ "monthly" ], "type": "string" } }, { "examples": { "default": { "value": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "type": "boolean" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "category": "Advertising", "description": "24/7 Media creates the tools for business advantage in the digital world.", "first_seen_date": "2018-04-21", "pricing_model": "Free", "status": "removed", "sub_category": "Publisher Ad Server", "technology": "24 7 Media" } ], "meta": { "last_updated": "2026-07-31", "query": { "asc": null, "limit": 5, "offset": 0, "sort": null }, "request": { "category": null, "domain": "cnn.com", "end_date": "2026-07-31", "format": "json", "granularity": "monthly", "main_domain_only": false, "metrics": [ "sub_category", "pricing_model", "description", "first_seen_date" ], "start_date": "2026-07-01", "status": "installed_and_removed" }, "status": "success" } }, "schema": { "properties": { "data": { "items": { "properties": { "category": { "type": "string" }, "description": { "type": "string" }, "first_seen_date": { "type": "string" }, "pricing_model": { "type": "string" }, "status": { "type": "string" }, "sub_category": { "type": "string" }, "technology": { "type": "string" } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/ResponseBd0Df3C14905_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Website Technologies", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported.", "The bound Similarweb v5 upstream documents a current technology snapshot for the last month, with monthly granularity only, not a historical time series. Required start_date and end_date must still be supplied under this public contract; use the latest available month. Source: https://docs.similarweb.com/api-v5/api-reference/website-analysis-api/website-content/website-technologies" ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-technologies", "x-aisa-pricing": { "cost_contract": "plan_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.75, "estimate_source": "profile_seed", "evidence_source": "request_snapshot", "request_cost_drivers": { "formula": { "fixed_units": 10 }, "inputs": [], "kind": "plan_units" }, "unit": "similarweb_credit", "unit_rate_usd": 0.075 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:4f24f4a4a2a4bd872e9470c71035b811e6e8671a44cd0bc1e249e1dbdf86c78e", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:3dc999be70aacef2e52112706b4fcd83d58c44c3e4344b88de20017677e21271", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "39144dc4e9b94e810b416d6ba602e0d732f31140825a867684cc45c97aa09f7b", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "39144dc4e9b94e810b416d6ba602e0d732f31140825a867684cc45c97aa09f7b", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "384a7d699622" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_technologies", "path": "/apis/v1/similarweb/website/technologies" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website/technologies?country=ww&domain=example.com&end_date=2026-09&granularity=monthly&limit=1&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website/top-sites-ranking": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.075 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_top_sites_ranking", "parameters": [ { "examples": { "default": { "value": "Finance" }, "minimal": { "value": "Finance" } }, "in": "query", "name": "category", "required": true, "schema": { "maxLength": 191, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "ww" }, "minimal": { "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": 1 }, "minimal": { "value": 1 } }, "in": "query", "name": "limit", "required": true, "schema": { "maximum": 20, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "maximum": 100000, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "domain": { "type": "string" }, "rank": { "type": "integer" } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/ResponseC6C9032778Bd_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Top Sites Ranking", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-top-sites-ranking", "x-aisa-pricing": { "cost_contract": "response_count", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.075, "estimate_source": "profile_seed", "evidence_source": "response_body", "maximum_units": 20, "reserve_plan_units": { "input": "limit", "input_multiplier": 1 }, "unit": "similarweb_credit", "unit_rate_usd": 0.075 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:982471773be027f8e3eaf5a26a3eb0f36fad6be922ca1083678916aa51cc1c33", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:02686e566ce70db40ff058c4d8dc2e88d48f0cde3a1c923fc089bd3dbd338fee", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:e00d85fb6dfa9292257b42febaee9ca380084ad14d7cad80b05ba3acc114c081", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "a349e6657c4c1da36fda2be6ea4e3489f6403922a07c0bc7da7e100635d4bfd0", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "a349e6657c4c1da36fda2be6ea4e3489f6403922a07c0bc7da7e100635d4bfd0", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "a349e6657c4c1da36fda2be6ea4e3489f6403922a07c0bc7da7e100635d4bfd0", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "14c28442c544" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_top_sites_ranking", "path": "/apis/v1/similarweb/website/top-sites-ranking" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website/top-sites-ranking?category=Finance&country=ww&limit=1' \\\n --header 'Authorization: Bearer '" } ] } }, "/apis/v1/similarweb/website/traffic-engagement": { "get": { "description": "\n按用量计费；默认请求预估费用：$0.075 USD（不是固定价格）。 声明的单位费率：每 similarweb_credit $0.075 USD。 最终费用以账户适用价格及实际结算为准。\n", "operationId": "get_similarweb_traffic_engagement", "parameters": [ { "examples": { "default": { "value": "ww" }, "minimal": { "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": "cnn.com" }, "minimal": { "value": "cnn.com" } }, "in": "query", "name": "domain", "required": true, "schema": { "maxLength": 253, "minLength": 1, "type": "string" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "end_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "granularity", "required": false, "schema": { "default": "monthly", "enum": [ "monthly" ], "type": "string" } }, { "in": "query", "name": "main_domain_only", "required": false, "schema": { "default": true, "type": "boolean" } }, { "examples": { "default": { "value": "visits" }, "minimal": { "value": "visits" } }, "in": "query", "name": "metrics", "required": true, "schema": { "type": "string", "x-aisa-delimiter": ",", "x-aisa-maxItems": 8, "x-aisa-minItems": 1 } }, { "in": "query", "name": "mtd", "required": false, "schema": { "type": "boolean" } }, { "examples": { "default": { "value": "2026-09" }, "minimal": { "value": "2026-09" } }, "in": "query", "name": "start_date", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "web_source", "required": false, "schema": { "enum": [ "desktop", "mobile_web", "total" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "average_visit_duration": { "description": "Average time on website (in seconds)", "format": "double", "type": [ "number", "null" ] }, "bounce_rate": { "description": "Percentage of visits that view only one page on the website", "format": "double", "type": [ "number", "null" ] }, "date": { "type": "string" }, "new_users": { "description": "Estimated number of new users to the website", "format": "double", "type": [ "number", "null" ] }, "page_views": { "description": "Estimated number of pages viewed on the website", "format": "double", "type": [ "number", "null" ] }, "pages_per_visit": { "description": "Average number of pages viewed per visit", "format": "double", "type": [ "number", "null" ] }, "returning_users": { "description": "Estimated number of returning users to the website", "format": "double", "type": [ "number", "null" ] }, "unique_visitors": { "description": "Estimated number of unique visitors (not deduplicated across devices) to the website", "format": "double", "type": [ "number", "null" ] }, "visits": { "description": "Estimated number of visits to the website", "format": "double", "type": [ "number", "null" ] } }, "type": "object" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/ResponseE0D24A93E9A2_SimilarWebMeta" } }, "type": "object" } } }, "description": "SimilarWeb v5 envelope (meta + data)." }, "default": { "content": { "application/json": { "schema": {} } }, "description": "Error response; upstream passthrough responses may use provider formats" } }, "summary": "Traffic & Engagement", "tags": [ "default" ], "x-aisa-capabilities": { "idempotency": "Idempotency-Key", "max_price": "X-AISA-Max-Price-USD", "mpp": false, "mpp_methods": [], "quote": { "header": "X-AISA-Cost-Mode", "value": "quote" }, "x402": false }, "x-aisa-catalog-id": "similarweb", "x-aisa-category": "1", "x-aisa-constraints": { "notes": [ "country supports ww only; default ww. State-level filtering is not supported." ] }, "x-aisa-docs-url": "https://aisa.one/docs/api-reference/similarweb/get_similarweb-website-traffic-engagement", "x-aisa-pricing": { "cost_contract": "plan_units", "customer_multiplier": 1.0, "customer_pricing": "provider_cost_multiplier", "default_request_estimate_usd": 0.075, "estimate_source": "profile_seed", "evidence_source": "request_snapshot", "request_cost_drivers": { "formula": { "input_multiplier": 1, "inputs": [ "metrics", "periods" ] }, "inputs": [ { "field": { "selector": "metrics", "source": "query" }, "kind": "array_length", "name": "metrics" }, { "allowed_granularities": [ "monthly" ], "default_buckets": { "monthly": 12 }, "end": { "selector": "end_date", "source": "query" }, "granularity": { "selector": "granularity", "source": "query" }, "kind": "calendar_buckets", "max": 120, "min": 1, "name": "periods", "start": { "selector": "start_date", "source": "query" } } ], "kind": "plan_units" }, "unit": "similarweb_credit", "unit_rate_usd": 0.075 }, "x-aisa-query-policy": { "ignore_undeclared": false, "request_wins": false }, "x-aisa-response-passthrough": true, "x-aisa-response-source": { "content_hash": "sha256:c0b8f9eb4323c8e0f02c684c6704485bd60740a528de559e5d105e4f24f3c960", "kind": "upstream_success_contract", "source": { "content_hash": "sha256:158eb9b0796c76f5c869602c6cd890452e035f07ec80a5c62eda63277999a06a", "converter": "reviewed-response-source-amendment@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "prior_source": { "content_hash": "sha256:70a3666af4cb71589b55ec07ba251f9692058edbee08350f129513251315fd08", "converter": "scripts/prepare_response_source_migration.py@1", "fetched_at": "2026-10-08T16:19:47.155165+00:00", "kind": "manual", "owner": "AIsa-team/docs", "path_space": "public", "policy_revision": "sha256:4f150b4d6bb7f0bf0c3cce58f9f98405661af0e4374e92d52f9ab77403aa4e97", "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_only": true, "review_evidence": "Retain the exact existing typed public response from pinned AIsa Docs 3a00a91fb8db83d033b3008209c0d598d3866c54; operation ID and public route match. The current SELECT-only metadata proves the same Profile reference as frozen W0, verified target ownership, no query/encoding/managed transform, and the expected official provider origin. No response fields, requiredness, examples, or status were inferred or widened. Actual complete current Runtime projection and release approval remain required.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "7651664b8ba7827e09ed083ef3ac9200e31e1a79d269d5310e77e265aea75d8a", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" }, "refresh_policy": "pinned", "refresh_reason": "Public response migration requires per-route binding and semantic review.", "response_contract_review": { "authority_url": "https://docs.similarweb.com/api-v5/api-reference/website-analysis-api/website-performance/traffic-and-engagement", "changes": [ { "after": { "description": "Estimated number of visits to the website", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].visits", "official_declaration": { "_id": "6a980b7cc0e28311fa0d68b6", "complexItems": [], "description": "Estimated number of visits to the website", "isRequired": false, "items": [], "name": "visits", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "863759115.0635419", "valueType": "number" } }, { "after": { "description": "Percentage of visits that view only one page on the website", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].bounce_rate", "official_declaration": { "_id": "6a980b7cc0e28311fa0d68b7", "complexItems": [], "description": "Percentage of visits that view only one page on the website", "isRequired": false, "items": [], "name": "bounce_rate", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "0.2755711666536945", "valueType": "number" } }, { "after": { "description": "Average time on website (in seconds)", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].average_visit_duration", "official_declaration": { "_id": "6a980b7cc0e28311fa0d68b8", "complexItems": [], "description": "Average time on website (in seconds)", "isRequired": false, "items": [], "name": "average_visit_duration", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "386.4105809929018", "valueType": "number" } }, { "after": { "description": "Average number of pages viewed per visit", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].pages_per_visit", "official_declaration": { "_id": "6a980b7cc0e28311fa0d68b9", "complexItems": [], "description": "Average number of pages viewed per visit", "isRequired": false, "items": [], "name": "pages_per_visit", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "3.7262894284076107", "valueType": "number" } }, { "after": { "description": "Estimated number of pages viewed on the website", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].page_views", "official_declaration": { "_id": "6a980b7cc0e28311fa0d68ba", "complexItems": [], "description": "Estimated number of pages viewed on the website", "isRequired": false, "items": [], "name": "page_views", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "3218616459.151989", "valueType": "number" } }, { "after": { "description": "Estimated number of unique visitors (not deduplicated across devices) to the website", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].unique_visitors", "official_declaration": { "_id": "6a980b7cc0e28311fa0d68bb", "complexItems": [], "description": "Estimated number of unique visitors (not deduplicated across devices) to the website", "isRequired": false, "items": [], "name": "unique_visitors", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "66083533.010000005", "valueType": "number" } }, { "after": { "description": "Estimated number of new users to the website", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].new_users", "official_declaration": { "_id": "6a980b7cc0e28311fa0d68bc", "complexItems": [], "description": "Estimated number of new users to the website", "isRequired": false, "items": [], "name": "new_users", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "11702160.986578166", "valueType": "number" } }, { "after": { "description": "Estimated number of returning users to the website", "format": "double", "type": [ "number", "null" ] }, "before": { "type": "number" }, "field": "data[].returning_users", "official_declaration": { "_id": "6a980b7cc0e28311fa0d68bd", "complexItems": [], "description": "Estimated number of returning users to the website", "isRequired": false, "items": [], "name": "returning_users", "options": { "format": "double", "nullable": true, "schemaNames": [], "xml": { "prefix": null } }, "value": "54381372.02597107", "valueType": "number" } } ], "file": "openapi/upstream/response-similarweb-get-06662d34ac365a61.json", "public_path": "/apis/v1/similarweb/website/traffic-engagement", "raw_content_hash": "sha256:26c5f17f3a0ecfc6c0d04f9bfe0cb252a9a5c65645754f93def604505006de81", "unresolved": [], "upstream_path": "/v5/website-analysis/websites/traffic-and-engagement" }, "response_only": true, "review_evidence": "Legacy request-region response samples removed; no observations were relabeled. Only explicit official scalar type/null declarations listed in response_contract_review are applied; unsupported array item declarations remain unresolved.", "review_period_days": 30, "source_document_sha256": "3ddebac85fe9511f569ef7c9dbf46219d24a229199dabcf08df77aa495a7e3fb", "source_revision": "3a00a91fb8db83d033b3008209c0d598d3866c54", "upstream_origin_sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "upstream_path_sha256": "7651664b8ba7827e09ed083ef3ac9200e31e1a79d269d5310e77e265aea75d8a", "url": "https://github.com/AIsa-team/docs/blob/3a00a91fb8db83d033b3008209c0d598d3866c54/openapi/similarweb.json" } }, "x-aisa-response-upstream-origin-sha256": "cd135ed3a725635bb3fd7296ead8914b1b89e97866e3cf06b574394d37ea40f0", "x-aisa-response-upstream-path-sha256": "7651664b8ba7827e09ed083ef3ac9200e31e1a79d269d5310e77e265aea75d8a", "x-aisa-revision": { "customer_pricing_ref": "d89caa405346", "plan_policy_version": "e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb", "profile_ref": "633efea4c156" }, "x-aisa-runtime-operation": { "method": "GET", "operation_id": "get_similarweb_traffic_engagement", "path": "/apis/v1/similarweb/website/traffic-engagement" }, "x-aisa-status": "enabled", "x-aisa-validation": "runtime", "x-codeSamples": [ { "label": "Reference example", "lang": "text", "source": "# Fixed reference example. Playground inputs do not update this sample.\ncurl --request GET \\\n --url 'https://api.aisa.one/apis/v1/similarweb/website/traffic-engagement?country=ww&domain=cnn.com&end_date=2026-09&metrics=visits&start_date=2026-09' \\\n --header 'Authorization: Bearer '" } ] } } }, "security": [ { "bearerAuth": [] } ], "servers": [ { "url": "https://api.aisa.one" } ] }