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

# Report get

> Performance report for the connected Reddit ad account: any level (account, campaign, ad group, ad), friendly metric names or metric groups, optional breakdowns (date, country, community, keyword, placement, …), a date preset or range in the account's time zone. Money is converted from Reddit's micro-units; rates in the summary are recomputed from sums. Rows beyond the byte budget are dropped with a notice — narrow the window, level or metrics rather than paging.

CLI: `adside reddit report get`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/reddit/report/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}/reddit/report/get:
    post:
      tags:
        - Reddit
      summary: Report get
      description: >-
        Performance report for the connected Reddit ad account: any level
        (account, campaign, ad group, ad), friendly metric names or metric
        groups, optional breakdowns (date, country, community, keyword,
        placement, …), a date preset or range in the account's time zone. Money
        is converted from Reddit's micro-units; rates in the summary are
        recomputed from sums. Rows beyond the byte budget are dropped with a
        notice — narrow the window, level or metrics rather than paging.


        CLI: `adside reddit report get`
      operationId: reddit.get_reddit_report
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                ad_account_id:
                  description: >-
                    Reddit ad account id (a2_…). Omit it: it defaults to the ad
                    account this workspace is connected to, and any other
                    account is refused.
                  type: string
                level:
                  default: campaign
                  description: One row per object at this level (plus any breakdowns).
                  type: string
                  enum:
                    - account
                    - campaign
                    - ad_group
                    - ad
                object_id:
                  description: >-
                    Restrict to one campaign / ad group / ad id (matched to
                    `level`).
                  type: string
                  pattern: ^\d{6,25}$
                metrics:
                  description: >-
                    Friendly metric names, e.g. impressions, clicks, spend, ctr,
                    cpc, ecpm, reach, video_watched_100_percent,
                    conversion_purchase_clicks. Default: the core group. See
                    `adside reddit report-fields list`.
                  type: array
                  items:
                    type: string
                metric_groups:
                  description: 'Bundles: core, video, conversions, value, app.'
                  type: array
                  items:
                    type: string
                    enum:
                      - core
                      - video
                      - conversions
                      - value
                      - app
                breakdowns:
                  description: >-
                    Extra dimensions: date, hour, country, region, dma,
                    community, interest, keyword, placement, os_type, gender,
                    language, asset_id, carousel_card. Max 3 in total (the level
                    counts as one). Reddit has no age breakdown.
                  type: array
                  items:
                    type: string
                preset:
                  description: >-
                    Shortcut for a date range. Default last_7d when no
                    start_date/end_date given.
                  type: string
                  enum:
                    - today
                    - yesterday
                    - last_7d
                    - last_14d
                    - last_30d
                    - this_month
                    - last_month
                start_date:
                  description: First day, YYYY-MM-DD, in time_zone_id.
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2}$
                end_date:
                  description: Last day (inclusive), YYYY-MM-DD, in time_zone_id.
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2}$
                time_zone_id:
                  description: >-
                    IANA zone for the date boundaries, e.g. Europe/Paris.
                    Defaults to the ad account's time zone.
                  type: string
                filter:
                  description: >-
                    Reddit filter syntax, e.g.
                    `campaign:effective_status==ACTIVE,ad:name=@promo` (==
                    exact, =@ contains, comma = OR).
                  type: string
                conversion_events:
                  description: Named custom pixel events to include (clicks, views, value).
                  type: array
                  items:
                    type: string
                sort_by:
                  description: Metric to sort rows by (descending). Default spend.
                  type: string
                format:
                  default: markdown
                  description: json only when fields must be reused programmatically.
                  type: string
                  enum:
                    - markdown
                    - json
                limit:
                  default: 200
                  type: integer
                  minimum: 1
                  maximum: 1000
      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.