> ## 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.

# Referrals

> Referrals — SimilarWeb



## OpenAPI

````yaml openapi/similarweb.json GET /similarweb/website/referrals
openapi: 3.0.3
info:
  title: SimilarWeb API
  version: 1.0.0
  description: >-
    SimilarWeb digital-intelligence data routed through the AIsa gateway:
    website traffic & engagement, ranking, traffic sources, audience, website
    content, and keyword/search insights.


    **Billing model**: SimilarWeb uses a two-phase (pre-authorization ->
    settlement) credit-based model, not a fixed unit price. (1) Before the call,
    an upper bound is estimated from the request dimensions and pre-authorized
    (response header `X-AISA-Estimated-Credits`); (2) the upstream call is made;
    (3) actual consumption is settled (response headers
    `X-AISA-Accounted-Credits`, `X-AISA-Price-USD`).

    - Billing dimensions: metrics x countries x time buckets (time-series
    endpoints); number of returned rows (list endpoints, capped at 20 rows,
    excess auto-truncated).

    - Countries: each country multiplies the cost once; world/global is
    normalized to world.

    - Settlement rounds up to whole credits; charged only when HTTP 2xx and data
    is non-empty; 4xx/5xx or empty data is not charged.
servers:
  - url: https://api.aisa.one/apis/v1
security:
  - BearerAuth: []
paths:
  /similarweb/website/referrals:
    get:
      summary: Referrals
      description: Referrals. Response follows the SimilarWeb v5 envelope (meta + data).
      operationId: similarwebReferrals
      parameters:
        - name: domain
          in: query
          required: true
          description: Target domain, e.g. example.com.
          schema:
            type: string
        - name: start_date
          in: query
          required: true
          description: Start month, format YYYY-MM.
          schema:
            type: string
        - name: end_date
          in: query
          required: true
          description: End month, format YYYY-MM.
          schema:
            type: string
        - name: granularity
          in: query
          required: false
          description: 'Time granularity. Allowed: monthly.'
          schema:
            type: string
            enum:
              - monthly
        - name: limit
          in: query
          required: true
          description: Number of rows to return; max 20, billed as 20 if exceeded.
          schema:
            type: integer
            default: 20
            maximum: 20
        - name: country
          in: query
          required: false
          description: >-
            Two-letter country code. Allowed: us, ww. Default: ww. Coverage is
            limited to ww and us on the current plan.
          schema:
            type: string
            enum:
              - us
              - ww
            default: ww
        - name: web_source
          in: query
          required: false
          description: 'Traffic source device split. Allowed: desktop, mobile_web, total.'
          schema:
            type: string
            enum:
              - desktop
              - mobile_web
              - total
        - name: main_domain_only
          in: query
          required: false
          description: Restrict to the main domain only (true/false).
          schema:
            type: boolean
        - name: offset
          in: query
          required: false
          description: Row offset for pagination.
          schema:
            type: integer
        - name: traffic_source
          in: query
          required: false
          description: Traffic-source filter.
          schema:
            type: string
      responses:
        '200':
          description: SimilarWeb v5 envelope (meta + data).
          content:
            application/json:
              example:
                meta:
                  query:
                    limit: 5
                    offset: 0
                    asc: null
                    sort: null
                  request:
                    referral_type: incoming
                    format: json
                    domain: cnn.com
                    granularity: monthly
                    country: us
                    start_date: '2026-06-01'
                    end_date: '2026-06-30'
                    web_source: total
                    main_domain_only: false
                  status: success
                  last_updated: '2026-07-31'
                data:
                  - domain: citizenfreepress.com
                    share: 0.1664343819749612
                    change: 0.44941053996464486
                    visits: 1083633.5339702675
              schema:
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/SimilarWebMeta'
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        domain:
                          type: string
                        share:
                          type: number
                        change:
                          type: number
                        visits:
                          type: number
components:
  schemas:
    SimilarWebMeta:
      type: object
      description: SimilarWeb v5 response envelope metadata.
      properties:
        status:
          type: string
          description: Upstream status; 'success' on a successful call.
          example: success
        last_updated:
          type: string
          description: Date of the most recent data point available upstream (YYYY-MM-DD).
          example: '2026-06-30'
        request:
          type: object
          description: >-
            Full echo of the normalized upstream request (parameters as
            received).
        query:
          type: object
          description: Pagination/sort echo when applicable (limit, offset, asc, sort).
      required:
        - status
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: AISA API Key

````