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

> Read comments on a creative across its ad variants

CLI: `adside reporting creatives comments`



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/workspaces/{workspaceId}/reporting/creatives/{adId}/comments
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}/comments:
    get:
      tags:
        - Reporting
      summary: Creatives comments
      description: |-
        Read comments on a creative across its ad variants

        CLI: `adside reporting creatives comments`
      operationId: reporting.creatives.comments
      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
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  comments:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        surface:
                          type: string
                          enum:
                            - facebook
                            - instagram
                            - tiktok
                            - youtube
                        message:
                          type: string
                        authorName:
                          anyOf:
                            - type: string
                            - type: 'null'
                        createdTime:
                          anyOf:
                            - type: string
                            - type: 'null'
                        likeCount:
                          type: number
                        replyCount:
                          type: number
                        parentCommentId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        permalinkUrl:
                          anyOf:
                            - type: string
                            - type: 'null'
                        hiddenAt:
                          anyOf:
                            - type: string
                            - type: 'null'
                        moderation:
                          type: object
                          properties:
                            canReply:
                              type: boolean
                            canHide:
                              type: boolean
                            reason:
                              anyOf:
                                - type: string
                                  enum:
                                    - not_owned
                                    - missing_scope
                                - type: 'null'
                          required:
                            - canReply
                            - canHide
                            - reason
                          additionalProperties: false
                      required:
                        - id
                        - surface
                        - message
                        - authorName
                        - createdTime
                        - likeCount
                        - replyCount
                        - parentCommentId
                        - permalinkUrl
                        - hiddenAt
                        - moderation
                      additionalProperties: false
                  totalCount:
                    type: number
                  coverage:
                    type: object
                    properties:
                      fbExternalPosts:
                        type: number
                      smartPlusAdGroups:
                        type: number
                      inFeedUncollectedComments:
                        type: number
                      youtubeCommentsUnavailable:
                        type: number
                    required:
                      - fbExternalPosts
                      - smartPlusAdGroups
                      - inFeedUncollectedComments
                      - youtubeCommentsUnavailable
                    additionalProperties: false
                required:
                  - comments
                  - totalCount
                  - coverage
                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.