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

# Feed

> Query and filter the workspace's cross-competitor ad feed

CLI: `adside research feed`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/research/feed/query
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}/research/feed/query:
    post:
      tags:
        - Research
      summary: Feed
      description: |-
        Query and filter the workspace's cross-competitor ad feed

        CLI: `adside research feed`
      operationId: research.feed
      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:
                channels:
                  type: array
                  items:
                    type: string
                    enum:
                      - META
                      - GOOGLE
                      - LINKEDIN
                trackedCompanyIds:
                  type: array
                  items:
                    type: string
                    format: cuid
                    pattern: ^[cC][^\s-]{8,}$
                collectionId:
                  anyOf:
                    - type: string
                      format: cuid
                      pattern: ^[cC][^\s-]{8,}$
                    - type: 'null'
                classification:
                  type: string
                  enum:
                    - COMPETITOR
                    - INSPIRATION
                    - SELF
                classifications:
                  minItems: 1
                  type: array
                  items:
                    type: string
                    enum:
                      - COMPETITOR
                      - INSPIRATION
                      - SELF
                landingPages:
                  type: array
                  items:
                    type: string
                    minLength: 1
                languages:
                  minItems: 1
                  type: array
                  items:
                    type: string
                    pattern: ^(?:[a-z]{2}|und)$
                aiTags:
                  type: object
                  propertyNames:
                    type: string
                    minLength: 1
                  additionalProperties:
                    minItems: 1
                    type: array
                    items:
                      type: string
                      minLength: 1
                formatTypes:
                  type: array
                  items:
                    type: string
                    enum:
                      - IMAGE
                      - VIDEO
                      - CAROUSEL
                daysActive:
                  type: string
                  enum:
                    - under7
                    - over7
                statuses:
                  type: array
                  items:
                    type: string
                    enum:
                      - active
                      - inactive
                adLengths:
                  type: array
                  items:
                    type: string
                    enum:
                      - under15
                      - 15to30
                      - 30to60
                      - over60
                sort:
                  default: newest
                  type: string
                  enum:
                    - newest
                    - longevity
                    - impressions
                cursor:
                  type: string
                limit:
                  default: 50
                  type: integer
                  minimum: 1
                  maximum: 100
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        ad:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties: {}
                        channel:
                          type: string
                          enum:
                            - META
                            - GOOGLE
                            - LINKEDIN
                        trackedCompany:
                          type: object
                          properties:
                            id:
                              type: string
                            nickname:
                              anyOf:
                                - type: string
                                - type: 'null'
                            companyProfile:
                              type: object
                              properties:
                                id:
                                  type: string
                                companyName:
                                  type: string
                                domain:
                                  type: string
                                logo:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                icon:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                              required:
                                - id
                                - companyName
                                - domain
                                - logo
                                - icon
                              additionalProperties: false
                          required:
                            - id
                            - nickname
                            - companyProfile
                          additionalProperties: false
                        startDate:
                          anyOf:
                            - type: string
                            - type: 'null'
                        endDate:
                          anyOf:
                            - type: string
                            - type: 'null'
                        daysRunning:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                      required:
                        - id
                        - ad
                        - channel
                        - trackedCompany
                        - startDate
                        - endDate
                        - daysRunning
                      additionalProperties: false
                  nextCursor:
                    anyOf:
                      - type: string
                      - type: 'null'
                  totals:
                    type: object
                    properties:
                      totalAds:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      byChannel:
                        type: object
                        properties:
                          META:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          GOOGLE:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          LINKEDIN:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                        required:
                          - META
                          - GOOGLE
                          - LINKEDIN
                        additionalProperties: false
                      byCompany:
                        type: array
                        items:
                          type: object
                          properties:
                            trackedCompanyId:
                              type: string
                            count:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                          required:
                            - trackedCompanyId
                            - count
                          additionalProperties: false
                    required:
                      - totalAds
                      - byChannel
                      - byCompany
                    additionalProperties: false
                  facets:
                    type: object
                    properties:
                      languages:
                        type: array
                        items:
                          type: string
                          pattern: ^(?:[a-z]{2}|und)$
                      aiTagCategories:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                            label:
                              type: string
                            options:
                              type: array
                              items:
                                type: object
                                properties:
                                  value:
                                    type: string
                                  label:
                                    type: string
                                required:
                                  - value
                                  - label
                                additionalProperties: false
                          required:
                            - key
                            - label
                            - options
                          additionalProperties: false
                      landingPages:
                        type: array
                        items:
                          type: object
                          properties:
                            value:
                              type: string
                            label:
                              type: string
                          required:
                            - value
                            - label
                          additionalProperties: false
                    required:
                      - languages
                      - aiTagCategories
                      - landingPages
                    additionalProperties: false
                required:
                  - items
                  - nextCursor
                  - totals
                  - facets
                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.