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

# Get vault analytics



## OpenAPI

````yaml get /v1/analytics/vault
openapi: 3.1.0
info:
  title: One of None API
  version: 1.0.0
  description: >-
    The One of None API manages product collections, registrations, short URLs,
    team operations, and rewards used by storefront integrations including
    Shopify discounts and redemption flows.
servers:
  - url: https://api.oneofnone.io
security:
  - ApiKeyAuth: []
paths:
  /v1/analytics/vault:
    get:
      summary: Get vault analytics
      parameters:
        - schema:
            type: string
          required: false
          name: team_id
          in: query
        - schema:
            type: string
          required: false
          name: team_slug
          in: query
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
          required: false
          name: team_ids
          in: query
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
          required: false
          name: team_slugs
          in: query
        - schema:
            type: string
          required: false
          name: collection_id
          in: query
        - schema:
            type: string
          required: false
          name: collection_slug
          in: query
        - schema:
            anyOf:
              - type: string
              - type: array
                items:
                  type: string
          required: false
          name: collection_ids
          in: query
        - schema:
            type: string
          required: false
          name: date_from
          in: query
        - schema:
            type: string
          required: false
          name: date_to
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 1000
          required: false
          name: limit
          in: query
        - schema:
            type:
              - integer
              - 'null'
          required: false
          name: offset
          in: query
        - schema:
            type: string
          required: false
          name: country_code
          in: query
        - schema:
            type: string
          required: false
          name: region_code
          in: query
        - schema:
            type: string
            enum:
              - mobile
              - tablet
              - desktop
              - all
          required: false
          name: device
          in: query
        - schema:
            type: string
          required: false
          name: browser
          in: query
        - schema:
            type: string
          required: false
          name: os
          in: query
        - schema:
            type: string
            enum:
              - daily
              - weekly
              - monthly
              - quarterly
              - yearly
          required: false
          name: aggregation
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
          required: false
          name: order
          in: query
        - schema:
            type: string
          required: false
          name: order_by
          in: query
        - schema:
            type: string
          required: false
          name: token_id
          in: query
        - schema:
            type: string
          required: false
          name: pathname
          in: query
        - schema:
            type: string
          required: false
          name: referrer
          in: query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultAnalyticsResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    VaultAnalyticsResponse:
      type: object
      properties:
        meta:
          type: object
          properties:
            pageviews:
              type: number
            sessions:
              type: number
            unique_visitors:
              type: number
            avg_session_duration:
              type:
                - number
                - 'null'
            bounce_rate:
              type:
                - number
                - 'null'
          required:
            - pageviews
            - sessions
            - unique_visitors
            - avg_session_duration
            - bounce_rate
        timeseries:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
              pageviews:
                type: number
              sessions:
                type: number
              unique_visitors:
                type: number
              avg_session_duration:
                type:
                  - number
                  - 'null'
              bounce_rate:
                type:
                  - number
                  - 'null'
            required:
              - date
              - pageviews
              - sessions
              - unique_visitors
              - avg_session_duration
              - bounce_rate
        top_pages:
          type: array
          items:
            type: object
            properties:
              name:
                type:
                  - string
                  - 'null'
              pageviews:
                type: number
              sessions:
                type: number
              unique_visitors:
                type: number
            required:
              - name
              - pageviews
              - sessions
              - unique_visitors
        top_referrers:
          type: array
          items:
            type: object
            properties:
              name:
                type:
                  - string
                  - 'null'
              pageviews:
                type: number
              sessions:
                type: number
              unique_visitors:
                type: number
            required:
              - name
              - pageviews
              - sessions
              - unique_visitors
        top_collections:
          type: array
          items:
            type: object
            properties:
              collection_id:
                type:
                  - string
                  - 'null'
              pageviews:
                type: number
              sessions:
                type: number
              unique_visitors:
                type: number
              collection:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  slug:
                    type: string
                  image:
                    type:
                      - object
                      - 'null'
                    properties:
                      url:
                        type:
                          - string
                          - 'null'
                required:
                  - id
            required:
              - collection_id
              - pageviews
              - sessions
              - unique_visitors
      required:
        - meta
        - timeseries
        - top_pages
        - top_referrers
        - top_collections
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````