> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shoppex.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get storefront traffic sources

> Storefront views by referrer, UTM source and campaign, country and device for a range of shop-local days.



## OpenAPI

````yaml /openapi.json get /dev/v1/analytics/traffic
openapi: 3.0.3
info:
  title: Shoppex Developer API
  description: Mintlify-compatible Developer API reference for Shoppex.
  version: 1.0.0
  contact:
    name: Shoppex Support
    email: support@shoppex.io
    url: https://shoppex.io
servers:
  - url: https://api.shoppex.io
security:
  - bearerAuth: []
paths:
  /dev/v1/analytics/traffic:
    get:
      tags:
        - Analytics
      summary: Get storefront traffic sources
      description: >-
        Storefront views by referrer, UTM source and campaign, country and
        device for a range of shop-local days.
      operationId: getDevV1AnalyticsTraffic
      parameters:
        - name: from
          in: query
          required: false
          schema:
            description: >-
              First shop-local day, YYYY-MM-DD. Give from and to together;
              without both the window is the last 30 days.
            type: string
        - name: to
          in: query
          required: false
          schema:
            description: Last shop-local day, YYYY-MM-DD. Give from and to together.
            type: string
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: object
                    required:
                      - timezone
                      - window
                      - views
                      - referrers
                      - utm_sources
                      - utm_campaigns
                      - countries
                      - devices
                    properties:
                      timezone:
                        type: string
                      window:
                        type: object
                        required:
                          - from
                          - to
                        properties:
                          from:
                            type: string
                          to:
                            type: string
                      views:
                        type: number
                      referrers:
                        type: array
                        items:
                          type: object
                          required:
                            - value
                            - visits
                            - percentage
                          properties:
                            value:
                              type: string
                              nullable: true
                            visits:
                              type: number
                            percentage:
                              type: number
                      utm_sources:
                        type: array
                        items:
                          type: object
                          required:
                            - value
                            - visits
                            - percentage
                          properties:
                            value:
                              type: string
                              nullable: true
                            visits:
                              type: number
                            percentage:
                              type: number
                      utm_campaigns:
                        type: array
                        items:
                          type: object
                          required:
                            - value
                            - visits
                            - percentage
                          properties:
                            value:
                              type: string
                              nullable: true
                            visits:
                              type: number
                            percentage:
                              type: number
                      countries:
                        type: array
                        items:
                          type: object
                          required:
                            - value
                            - visits
                            - percentage
                          properties:
                            value:
                              type: string
                              nullable: true
                            visits:
                              type: number
                            percentage:
                              type: number
                      devices:
                        type: array
                        items:
                          type: object
                          required:
                            - value
                            - visits
                            - percentage
                          properties:
                            value:
                              type: string
                              nullable: true
                            visits:
                              type: number
                            percentage:
                              type: number
                additionalProperties: true
        '401':
          description: Response for status 401
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
        '403':
          description: Response for status 403
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
        '404':
          description: Response for status 404
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
        '422':
          description: Response for status 422
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
        '429':
          description: Response for status 429
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
        '500':
          description: Response for status 500
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - code
                      - message
                      - doc_url
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      doc_url:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          required:
                            - field
                            - message
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          additionalProperties: true
                      subcode:
                        type: string
                    additionalProperties: true
                additionalProperties: true
      deprecated: false
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: Use your Shoppex API key in the Authorization header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.