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

> Get top creatives

CLI: `adside reporting creatives rank`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/reporting/creatives/rank
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/rank:
    post:
      tags:
        - Reporting
      summary: Creatives rank
      description: |-
        Get top creatives

        CLI: `adside reporting creatives rank`
      operationId: reporting.creatives.rank
      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:
                source:
                  default: META
                  description: >-
                    Ad platform to read: META, TIKTOK, GOOGLE (YouTube video
                    ads), LINKEDIN, SNAPCHAT or REDDIT. Defaults to META.
                  type: string
                  enum:
                    - META
                    - TIKTOK
                    - GOOGLE
                    - LINKEDIN
                    - SNAPCHAT
                    - REDDIT
                from:
                  description: >-
                    Inclusive start date, yyyy-MM-dd. Use together with `to`;
                    takes precedence over `period`.
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2}$
                to:
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2}$
                  description: Inclusive end date, yyyy-MM-dd.
                period:
                  default: last_7_days
                  description: Preset window used when `from`/`to` are omitted.
                  type: string
                  enum:
                    - today
                    - yesterday
                    - last_7_days
                    - last_4_weeks
                    - last_3_months
                    - last_12_months
                    - week_to_date
                    - month_to_date
                    - quarter_to_date
                    - year_to_date
                    - all_time
                    - last_30_days
                limit:
                  default: 10
                  description: How many creatives to return (1-20). Defaults to 10.
                  type: integer
                  minimum: 1
                  maximum: 20
                format:
                  default: all
                  description: Keep only video or static creatives. Defaults to all.
                  type: string
                  enum:
                    - all
                    - video
                    - static
                sortBy:
                  default: spend
                  description: >-
                    Ranking column. `conversion` ranks by the conversion event
                    (see `conversionEvent` / `sortSubMetric`). A column the
                    platform cannot sort by falls back to spend.
                  type: string
                  enum:
                    - spend
                    - impressions
                    - reach
                    - clicks
                    - frequency
                    - ctr
                    - cpm
                    - cpc
                    - thumbstop
                    - conversion
                    - comments
                sortOrder:
                  default: desc
                  description: >-
                    desc = highest first (use asc with cost metrics for
                    cheapest).
                  type: string
                  enum:
                    - asc
                    - desc
                sortSubMetric:
                  description: >-
                    With sortBy `conversion`: which conversion figure to rank by
                    — count, costPer, rate, value or roas. Defaults to count.
                  type: string
                  enum:
                    - costPer
                    - count
                    - rate
                    - value
                    - roas
                conversionEvent:
                  description: >-
                    Platform conversion event to report (e.g. a Meta
                    action_type). Defaults to the workspace's primary mapped
                    conversion for the platform.
                  type: string
                  minLength: 1
                  maxLength: 256
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  text:
                    type: string
                required:
                  - text
                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.