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

# Themes list

> Compare performance by messaging theme

CLI: `adside reporting themes list`



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/workspaces/{workspaceId}/reporting/themes
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}/reporting/themes:
    get:
      tags:
        - Reporting
      summary: Themes list
      description: |-
        Compare performance by messaging theme

        CLI: `adside reporting themes list`
      operationId: reporting.themes.list
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: from
          in: query
          required: true
          schema:
            type: string
            format: date
            pattern: >-
              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          style: form
          explode: true
        - name: to
          in: query
          required: true
          schema:
            type: string
            format: date
            pattern: >-
              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          style: form
          explode: true
        - name: source
          in: query
          required: false
          schema:
            default: META
            type: string
            enum:
              - META
              - TIKTOK
              - GOOGLE
              - SNAPCHAT
              - REDDIT
          style: form
          explode: true
        - name: sortBy
          in: query
          required: false
          schema:
            default: spend
            type: string
            enum:
              - spend
              - impressions
              - reach
              - clicks
              - frequency
              - ctr
              - cpm
              - cpc
              - thumbstop
              - conversion
              - comments
              - winnerCreativeCount
              - creativeCount
              - totalAdCount
              - activeCreativeCount
          style: form
          explode: true
        - name: sortOrder
          in: query
          required: false
          schema:
            default: desc
            type: string
            enum:
              - asc
              - desc
          style: form
          explode: true
        - name: sortEvent
          in: query
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 256
          style: form
          explode: true
        - name: sortSubMetric
          in: query
          required: false
          schema:
            type: string
            enum:
              - costPer
              - count
              - rate
              - value
              - roas
          style: form
          explode: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - never_synced
                      - syncing
                      - preparing
                      - ready
                      - partial
                      - failed
                  lastClusteredAt:
                    anyOf:
                      - type: string
                      - type: 'null'
                  coverage:
                    type: object
                    properties:
                      eligibleCreatives:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      assignedCreatives:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                    required:
                      - eligibleCreatives
                      - assignedCreatives
                    additionalProperties: false
                  themes:
                    type: array
                    items:
                      type: object
                      properties:
                        totalCreativeCount:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        winnerCreativeCount:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        id:
                          type: string
                        name:
                          type: string
                        description:
                          type: string
                        spend:
                          type: number
                        creativeCount:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        totalAdCount:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        activeCreativeCount:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        previews:
                          type: array
                          items:
                            type: object
                            properties:
                              channel:
                                type: string
                                enum:
                                  - META
                                  - GOOGLE_ADS
                                  - GOOGLE_DRIVE
                                  - GOOGLE_TAG_MANAGER
                                  - GOOGLE_ANALYTICS
                                  - POSTHOG
                                  - TIKTOK
                                  - LINKEDIN
                                  - SNAPCHAT
                                  - REDDIT
                                  - X
                                  - CANVA
                                  - FIGMA
                                  - GITHUB
                              sourceCreativeId:
                                type: string
                              thumbnailUrl:
                                anyOf:
                                  - type: string
                                    format: uri
                                  - type: 'null'
                            required:
                              - channel
                              - sourceCreativeId
                              - thumbnailUrl
                            additionalProperties: false
                        metricRow:
                          type: object
                          properties:
                            impressions:
                              anyOf:
                                - type: number
                                - type: 'null'
                            clicks:
                              anyOf:
                                - type: number
                                - type: 'null'
                            reach:
                              anyOf:
                                - type: number
                                - type: 'null'
                            spend:
                              anyOf:
                                - type: number
                                - type: 'null'
                            actions:
                              type: object
                              propertyNames:
                                type: string
                              additionalProperties:
                                type: number
                            costPerAction:
                              type: object
                              propertyNames:
                                type: string
                              additionalProperties:
                                type: number
                            actionValues:
                              default: {}
                              type: object
                              propertyNames:
                                type: string
                              additionalProperties:
                                type: number
                            comments:
                              anyOf:
                                - type: number
                                - type: 'null'
                            videoPlays:
                              anyOf:
                                - type: number
                                - type: 'null'
                            video3s:
                              anyOf:
                                - type: number
                                - type: 'null'
                            video15s:
                              anyOf:
                                - type: number
                                - type: 'null'
                            video30s:
                              anyOf:
                                - type: number
                                - type: 'null'
                            videoAvgTime:
                              anyOf:
                                - type: number
                                - type: 'null'
                            videoP25:
                              anyOf:
                                - type: number
                                - type: 'null'
                            videoP50:
                              anyOf:
                                - type: number
                                - type: 'null'
                            videoP75:
                              anyOf:
                                - type: number
                                - type: 'null'
                            videoP95:
                              anyOf:
                                - type: number
                                - type: 'null'
                            videoP100:
                              anyOf:
                                - type: number
                                - type: 'null'
                            viewRate:
                              anyOf:
                                - type: number
                                - type: 'null'
                            completionP25:
                              anyOf:
                                - type: number
                                - type: 'null'
                            completionP50:
                              anyOf:
                                - type: number
                                - type: 'null'
                            completionP75:
                              anyOf:
                                - type: number
                                - type: 'null'
                            completionP100:
                              anyOf:
                                - type: number
                                - type: 'null'
                          required:
                            - impressions
                            - clicks
                            - reach
                            - spend
                            - actions
                            - costPerAction
                            - actionValues
                            - video3s
                            - video15s
                            - video30s
                            - videoAvgTime
                            - videoP25
                            - videoP50
                            - videoP75
                            - videoP95
                            - videoP100
                          additionalProperties: false
                      required:
                        - totalCreativeCount
                        - winnerCreativeCount
                        - id
                        - name
                        - description
                        - spend
                        - creativeCount
                        - totalAdCount
                        - activeCreativeCount
                        - previews
                        - metricRow
                      additionalProperties: false
                required:
                  - status
                  - lastClusteredAt
                  - coverage
                  - themes
                additionalProperties: false
      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.