> ## Documentation Index
> Fetch the complete documentation index at: https://similarweb-zp8zf.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Websites Dataset (Traffic and Engagement)

> The Websites dataset offers a comprehensive analysis of website traffic and user engagement. It encompasses various metrics that provide insights into how visitors interact with websites, both on desktop and mobile platforms. This dataset is crucial for understanding website performance, audience behavior, and digital marketing effectiveness.



## OpenAPI

````yaml batch-api.json post /batch/v4/request-report
openapi: 3.1.0
info:
  title: NEW Batch API
  version: '4.0'
servers:
  - url: https://api.similarweb.com
security:
  - sec0: []
paths:
  /batch/v4/request-report:
    post:
      summary: Websites Dataset (Traffic and Engagement)
      description: >-
        The Websites dataset offers a comprehensive analysis of website traffic
        and user engagement. It encompasses various metrics that provide
        insights into how visitors interact with websites, both on desktop and
        mobile platforms. This dataset is crucial for understanding website
        performance, audience behavior, and digital marketing effectiveness.
      operationId: websites-dataset
      parameters:
        - name: api-key
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - report_query
                - delivery_information
              properties:
                report_query:
                  type: object
                  properties:
                    tables:
                      type: array
                      items:
                        properties:
                          vtable:
                            type: string
                            description: >-
                              Mandatory. Select the table you would like to
                              query from.
                            default: traffic_and_engagement
                          granularity:
                            type: string
                            description: Mandatory. Select the data granularity.
                            default: monthly
                          filters:
                            type: object
                            description: Filter upon the table.
                            properties:
                              domains:
                                type: array
                                description: >-
                                  Optional. Available based on the "vtable"
                                  selected.
                                default:
                                  - nike.com
                                items:
                                  type: string
                              countries:
                                type: array
                                description: >-
                                  Optional. Countries represented as Country
                                  Code Alpha-2, example - US (United States), IL
                                  (Israel), GB (Great Britain), WW (World-wide).
                                default:
                                  - UK
                                items:
                                  type: string
                              include_subdomains:
                                type: boolean
                                description: >-
                                  Optional. Available based on the "vtable"
                                  selected.
                                default: true
                          metrics:
                            type: array
                            description: Select the relevant metrics for your report.
                            default: []
                            items:
                              type: string
                          start_date:
                            type: string
                            default: 2024-08
                          end_date:
                            type: string
                            default: 2024-08
                          paging:
                            type: object
                            description: Set pagination configuration.
                            properties:
                              sort_asc:
                                type: string
                                description: >-
                                  Optional. default is False, decides if to sort
                                  ascending or descending.
                                default: 'false'
                              sort:
                                type: string
                                description: >-
                                  Optional. Set the metric you want the report
                                  to be sorted upon. by default takes the first
                                  metric specified.
                              limit:
                                type: integer
                                description: Optional. default value varies per "vtable".
                                default: 100
                                format: int32
                              offset:
                                type: integer
                                description: Optional. default is 0. Set the offset.
                                default: 0
                                format: int32
                          latest:
                            type: boolean
                            description: >-
                              Optional. When set will override the last
                              available date on the end_date.
                        required:
                          - vtable
                          - granularity
                          - metrics
                        type: object
                delivery_information:
                  type: object
                  required:
                    - delivery_method
                    - response_format
                  properties:
                    delivery_method:
                      type: string
                      description: Set the Delivery Method.
                      enum:
                        - download_link
                        - bucket_access
                        - snowflake
                    response_format:
                      type: string
                      description: >-
                        Mandatory only for "download_link" and "bucket_access"
                        delivery methods. Set the File format of the generated
                        report.
                      enum:
                        - json
                        - csv
                        - parquet
                        - orc
                    webhook_url:
                      type: string
                      description: >-
                        Optional. Set a webhook url to trigger when the report
                        status is changed.
                    delivery_method_params:
                      type: object
                      description: >-
                        Optional. only relevant for delivery methods -
                        "snowflake" and "bucket_access". Set delivery method
                        configurations.
                      properties: {}
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: |-
                    {
                        "report_id": "c4asdf83d8-bf42-40a1-b3d2-8862832dbc55",
                        "status": "pending"
                    }
              schema:
                type: object
                properties:
                  report_id:
                    type: string
                    example: c4asdf83d8-bf42-40a1-b3d2-8862832dbc55
                  status:
                    type: string
                    example: pending
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: api-key

````