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

# Creatives get

> Read performance and breakdowns for a creative

CLI: `adside reporting creatives get`



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/workspaces/{workspaceId}/reporting/creatives/{adId}
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/creatives/{adId}:
    get:
      tags:
        - Reporting
      summary: Creatives get
      description: |-
        Read performance and breakdowns for a creative

        CLI: `adside reporting creatives get`
      operationId: reporting.creatives.get
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: adId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 256
        - name: source
          in: query
          required: false
          schema:
            default: META
            type: string
            enum:
              - META
              - TIKTOK
              - GOOGLE
              - LINKEDIN
              - SNAPCHAT
              - REDDIT
          style: form
          explode: true
        - name: from
          in: query
          required: true
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
          style: form
          explode: true
        - name: to
          in: query
          required: true
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
          style: form
          explode: true
        - name: groupBy
          in: query
          required: false
          schema:
            default: ad
            type: string
            enum:
              - ad
              - media
          style: form
          explode: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      ad:
                        type: object
                        properties:
                          adId:
                            type: string
                          sourceCreativeId:
                            type: string
                          aiAnalysisPreview:
                            type: object
                            properties:
                              status:
                                type: string
                                enum:
                                  - PENDING
                                  - RUNNING
                                  - COMPLETED
                                  - FAILED
                              coreMessage:
                                type: string
                              tagCount:
                                default: 0
                                type: integer
                                minimum: 0
                                maximum: 9007199254740991
                              tags:
                                default: []
                                type: array
                                items:
                                  type: object
                                  properties:
                                    categoryKey:
                                      type: string
                                    categoryLabel:
                                      type: string
                                    tag:
                                      type: string
                                  required:
                                    - categoryKey
                                    - categoryLabel
                                    - tag
                                  additionalProperties: false
                            required:
                              - status
                              - tagCount
                              - tags
                            additionalProperties: false
                          name:
                            type: string
                          source:
                            type: string
                            enum:
                              - META
                              - TIKTOK
                              - GOOGLE
                              - LINKEDIN
                              - SNAPCHAT
                              - REDDIT
                          thumbnailUrl:
                            type: string
                            format: uri
                          videoUrl:
                            type: string
                            format: uri
                          spend:
                            type: number
                          actions:
                            type: array
                            items:
                              type: object
                              properties:
                                type:
                                  type: string
                                count:
                                  type: number
                              required:
                                - type
                                - count
                              additionalProperties: false
                          costPerAction:
                            type: array
                            items:
                              type: object
                              properties:
                                type:
                                  type: string
                                value:
                                  type: number
                              required:
                                - type
                                - value
                              additionalProperties: false
                          actionValues:
                            type: array
                            items:
                              type: object
                              properties:
                                type:
                                  type: string
                                value:
                                  type: number
                              required:
                                - type
                                - value
                              additionalProperties: false
                          createdTime:
                            type: string
                          impressions:
                            type: number
                          clicks:
                            type: number
                          reach:
                            type: number
                          video15sCount:
                            type: number
                          video3sCount:
                            type: number
                          videoPlays:
                            type: number
                          format:
                            type: string
                            enum:
                              - video
                              - static
                          isActive:
                            type: boolean
                          landingUrl:
                            type: string
                          landingUrlCount:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          comments:
                            type: number
                          commentSentiment:
                            anyOf:
                              - type: object
                                properties:
                                  positivePercentage:
                                    type: integer
                                    minimum: 0
                                    maximum: 100
                                  sampleSize:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  totalComments:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  positive:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  neutral:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  negative:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  noSentiment:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  excluded:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  failedOrPending:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                required:
                                  - positivePercentage
                                  - sampleSize
                                  - totalComments
                                  - positive
                                  - neutral
                                  - negative
                                  - noSentiment
                                  - excluded
                                  - failedOrPending
                                additionalProperties: false
                              - type: object
                                properties:
                                  status:
                                    type: string
                                    const: insufficient_sample
                                  sampleSize:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  minimumSampleSize:
                                    type: integer
                                    exclusiveMinimum: 0
                                    maximum: 9007199254740991
                                  totalComments:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  positive:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  neutral:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  negative:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  noSentiment:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  excluded:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                  failedOrPending:
                                    type: integer
                                    minimum: 0
                                    maximum: 9007199254740991
                                required:
                                  - status
                                  - sampleSize
                                  - minimumSampleSize
                                  - totalComments
                                  - positive
                                  - neutral
                                  - negative
                                  - noSentiment
                                  - excluded
                                  - failedOrPending
                                additionalProperties: false
                          adCount:
                            type: number
                          activeAdCount:
                            type: number
                          viewRate:
                            type: number
                          completionP25:
                            type: number
                          completionP50:
                            type: number
                          completionP75:
                            type: number
                          completionP100:
                            type: number
                        required:
                          - adId
                          - name
                          - spend
                          - actions
                          - costPerAction
                          - createdTime
                        additionalProperties: false
                      accountId:
                        type: string
                      ageGender:
                        type: array
                        items:
                          type: object
                          properties:
                            age:
                              type: string
                            gender:
                              type: string
                            impressions:
                              type: number
                            clicks:
                              type: number
                            spend:
                              type: number
                          required:
                            - age
                            - gender
                            - impressions
                            - clicks
                            - spend
                          additionalProperties: false
                      platforms:
                        type: array
                        items:
                          type: object
                          properties:
                            platform:
                              type: string
                            impressions:
                              type: number
                            clicks:
                              type: number
                            spend:
                              type: number
                          required:
                            - platform
                            - impressions
                            - clicks
                            - spend
                          additionalProperties: false
                      devices:
                        type: array
                        items:
                          type: object
                          properties:
                            device:
                              type: string
                            impressions:
                              type: number
                            clicks:
                              type: number
                            spend:
                              type: number
                          required:
                            - device
                            - impressions
                            - clicks
                            - spend
                          additionalProperties: false
                      videoRetention:
                        anyOf:
                          - type: object
                            properties:
                              videoP25:
                                type: number
                              videoP50:
                                type: number
                              videoP75:
                                type: number
                              videoP95:
                                anyOf:
                                  - type: number
                                  - type: 'null'
                              videoP100:
                                type: number
                              videoPlays:
                                type: number
                              videoAvgTime:
                                anyOf:
                                  - type: number
                                  - type: 'null'
                            required:
                              - videoP25
                              - videoP50
                              - videoP75
                              - videoP95
                              - videoP100
                              - videoPlays
                              - videoAvgTime
                            additionalProperties: false
                          - type: 'null'
                      dailySpend:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            spend:
                              type: number
                          required:
                            - date
                            - spend
                          additionalProperties: false
                      dailyMetrics:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            spend:
                              type: number
                            impressions:
                              type: number
                            clicks:
                              type: number
                            reach:
                              type: number
                            video3s:
                              type: number
                            video15s:
                              type: number
                            videoPlays:
                              type: number
                            actions:
                              type: array
                              items:
                                type: object
                                properties:
                                  type:
                                    type: string
                                  count:
                                    type: number
                                required:
                                  - type
                                  - count
                                additionalProperties: false
                            actionValues:
                              type: array
                              items:
                                type: object
                                properties:
                                  type:
                                    type: string
                                  value:
                                    type: number
                                required:
                                  - type
                                  - value
                                additionalProperties: false
                            viewRate:
                              type: number
                            completionP25:
                              type: number
                            completionP50:
                              type: number
                            completionP75:
                              type: number
                            completionP100:
                              type: number
                          required:
                            - date
                            - spend
                            - impressions
                            - clicks
                          additionalProperties: false
                      adBreakdown:
                        type: array
                        items:
                          type: object
                          properties:
                            adId:
                              type: string
                            name:
                              type: string
                            status:
                              type: string
                            approval:
                              type: string
                            isActive:
                              type: boolean
                            spend:
                              type: number
                            impressions:
                              type: number
                            clicks:
                              type: number
                            primaryText:
                              type: string
                            headline:
                              type: string
                            description:
                              type: string
                            callToAction:
                              type: string
                            landingUrl:
                              type: string
                          required:
                            - adId
                            - name
                            - status
                            - isActive
                            - spend
                            - impressions
                            - clicks
                          additionalProperties: false
                    required:
                      - ad
                      - ageGender
                      - platforms
                      - videoRetention
                    additionalProperties: false
                required:
                  - data
                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.