> ## Documentation Index > Fetch the complete documentation index at: https://aisa.one/docs/llms.txt > Use this file to discover all available pages before exploring further. # Segments Analysis ## OpenAPI ````yaml openapi/zh/similarweb.json GET /apis/v1/similarweb/segment-analysis/segments/traffic-and-engagement openapi: 3.1.0 info: description: '' title: SimilarWeb version: '1' x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote x-aisa-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: facts_hash: bf0a943545b35cda0e031b014cbcd770c36bc4252d6bfe32119b7382675184dd generator_version: '2' protocol_version: '1' schema_version: '1' seed_month: 2026-09 composer_version: '13' response_pending: - operation_id: get_similarweb_apis_v1_similarweb_keyword_analysi_490801 path: /apis/v1/similarweb/keyword-analysis/keywords/overview method: GET statuses: - '200' reason: public success response has no authoritative payload declaration - operation_id: get_similarweb_apis_v1_similarweb_segment_analysi_6349fe path: /apis/v1/similarweb/segment-analysis/segments/traffic-sources method: GET statuses: - '200' reason: public success response has no authoritative payload declaration - operation_id: get_similarweb_apis_v1_similarweb_website_analysi_850464 path: /apis/v1/similarweb/website-analysis/websites/conversion-rates method: GET statuses: - '200' reason: public success response has no authoritative payload declaration - operation_id: get_similarweb_apis_v1_similarweb_website_analysi_7399a9 path: >- /apis/v1/similarweb/website-analysis/websites/conversion-rates/aggregated method: GET statuses: - '200' reason: public success response has no authoritative payload declaration - operation_id: get_similarweb_apis_v1_similarweb_website_analysi_aa2e1f path: >- /apis/v1/similarweb/website-analysis/websites/traffic-by-demographics/aggregated method: GET statuses: - '200' reason: public success response has no authoritative payload declaration - operation_id: similarwebFolders path: /apis/v1/similarweb/website/folders method: GET statuses: - '200' reason: public success response has no authoritative payload declaration document_hash: sha256:8bb3cc0dbe2e5ecb91a1ce4fdf519e1caf8bf877bd2b1e7af76092c64ad23977 x-aisa-plans: builder: 1 display_plan: similarweb_payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-provider: similarweb x-aisa-catalogs: similarweb: title: SimilarWeb description: '' x-aisa-document: facts_hash: bf0a943545b35cda0e031b014cbcd770c36bc4252d6bfe32119b7382675184dd generator_version: '2' protocol_version: '1' schema_version: '1' seed_month: 2026-09 x-aisa-plans: builder: 1 display_plan: similarweb_payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote servers: - url: https://api.aisa.one security: - bearerAuth: [] paths: /apis/v1/similarweb/segment-analysis/segments/traffic-and-engagement: get: tags: - default summary: Segments Analysis operationId: get_similarweb_apis_v1_similarweb_segment_analysi_64e47c 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 - in: query name: main_domain_only required: false schema: type: boolean - examples: default: value: example minimal: value: example in: query name: metrics required: true schema: type: string x-aisa-delimiter: ',' x-aisa-maxItems: 8 x-aisa-minItems: 1 - examples: default: value: example minimal: value: example in: query name: segment required: true schema: 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: OK content: application/json: schema: type: object properties: meta: type: object properties: request: type: object properties: format: type: string description: Format in which the reply should be returned enum: - json - xml segment: type: string example: a4a9eadc-09ff-4f0b-beb2-40f7c5d07599 minLength: 1 description: Segment ID to analyze granularity: type: string example: monthly description: Time granularity for the returned values enum: - daily - weekly - monthly country: type: - string - 'null' example: us description: Two-letter country code (e.g., 'us', 'gb', 'ww') start_date: type: - string - 'null' example: '2025-10-01' format: date-time description: >- Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago end_date: type: - string - 'null' example: '2025-10-30' format: date-time description: >- End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago web_source: type: string description: The device/platform the traffic is coming from enum: - desktop - mobile_web - total metrics: type: - array - 'null' description: >- Comma-separated list of metrics: visits, bounce_rate, page_views, average_visit_duration, pages_per_visit, share, unique_visitors items: type: string enum: - visits - bounce_rate - page_views - average_visit_duration - pages_per_visit - share - unique_visitors mtd: type: boolean description: >- When 'true', end_date is set to the latest available days' data (month-to-date). To use, set granularity to 'daily' required: - segment status: type: string enum: - success - error error_code: type: - integer - 'null' example: '200' format: int32 error_message: type: - string - 'null' last_updated: type: - string - 'null' example: '2025-10-30' format: date-time data_type: type: string enum: - not_applicable - estimated - verified data: type: - array - 'null' items: type: - object - 'null' properties: date: type: string example: '2025-10-01' format: date-time description: >- Date of the requested data in 'YYYY-MM' or 'YYYY-MM-DD' format visits: type: - number - 'null' example: '2655.3025' format: double description: Estimated number of visits to the website bounce_rate: type: - number - 'null' example: '0.15913776' format: double description: >- Percentage of visits that view only one page on the website pages_per_visit: type: - number - 'null' example: '0.9947667' format: double description: Average number of pages viewed per visit average_visit_duration: type: - number - 'null' format: double description: Average time on website (in seconds) page_views: type: - number - 'null' example: '2641.4065' format: double description: Estimated number of pages viewed on the website share: type: - number - 'null' example: '0.014075259' format: double description: >- Percentage of total site traffic that comes from this segment unique_visitors: type: - number - 'null' example: '1834.0046' format: double description: >- Estimated number of unique visitors (not deduplicated across devices) to the website confidence: type: string enum: - high - low - very_low default: content: application/json: schema: {} description: >- Error response; upstream passthrough responses may use provider formats components: securitySchemes: bearerAuth: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.