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

# Stats get

> Get Snapchat delivery/reach/conversion stats for an ad account, campaign, ad squad, or ad. `spend` and every `*_value` conversion metric are returned already converted from Snapchat's micro-currency to the ad account's normal currency units (÷ 1,000,000).

CLI: `adside snapchat stats get`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/snapchat/stats/get
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/workspaces/{workspaceId}/snapchat/stats/get:
    post:
      tags:
        - Snapchat
      summary: Stats get
      description: >-
        Get Snapchat delivery/reach/conversion stats for an ad account,
        campaign, ad squad, or ad. `spend` and every `*_value` conversion metric
        are returned already converted from Snapchat's micro-currency to the ad
        account's normal currency units (÷ 1,000,000).


        CLI: `adside snapchat stats get`
      operationId: snapchat.get_stats
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                entity_level:
                  type: string
                  enum:
                    - adaccount
                    - campaign
                    - adsquad
                    - ad
                  description: Which level of the hierarchy to pull stats for
                entity_id:
                  description: >-
                    Required for campaign/adsquad/ad. For adaccount, omit it: it
                    defaults to the ad account this workspace is connected to,
                    and any other account is refused.
                  type: string
                granularity:
                  default: DAY
                  description: >-
                    DAY needs start_time/end_time within 31 days; HOUR within 7
                    days; TOTAL/LIFETIME need no date range (LIFETIME is
                    finalized-only data).
                  type: string
                  enum:
                    - TOTAL
                    - DAY
                    - HOUR
                    - LIFETIME
                breakdown:
                  description: >-
                    One call per parent: 'ad' at any level, 'adsquad' on a
                    campaign, 'campaign' on an ad account.
                  type: string
                  enum:
                    - ad
                    - adsquad
                    - campaign
                fields:
                  default:
                    - impressions
                    - swipes
                    - spend
                    - video_views
                    - quartile_1
                    - quartile_2
                    - quartile_3
                    - view_completion
                    - conversion_purchases
                    - conversion_sign_ups
                    - conversion_purchases_value
                  description: >-
                    Metric names, e.g. impressions, swipes, spend,
                    video_views_5s
                  type: array
                  items:
                    type: string
                start_time:
                  description: ISO 8601, required for DAY/HOUR granularity
                  type: string
                end_time:
                  description: ISO 8601, required for DAY/HOUR granularity
                  type: string
                dimension:
                  description: Insights breakdown dimension (DAY/TOTAL/LIFETIME only)
                  type: string
                  enum:
                    - GEO
                    - DEMO
                    - INTEREST
                    - DEVICE
                pivot:
                  description: >-
                    Pivot fields for the chosen dimension, e.g.
                    gender,age_bucket for DEMO
                  type: array
                  items:
                    type: string
                swipe_up_attribution_window:
                  description: Default 28_DAY
                  type: string
                  enum:
                    - 1_DAY
                    - 7_DAY
                    - 28_DAY
                view_attribution_window:
                  description: Default 1_DAY
                  type: string
                  enum:
                    - none
                    - 1_HOUR
                    - 3_HOUR
                    - 6_HOUR
                    - 1_DAY
                    - 7_DAY
              required:
                - entity_level
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

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