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

# Performance rank

> Rank a dimension (campaigns, ad groups, ads, communities, keywords, interests, placements, countries, …) by one metric over a window, with a minimum-spend floor. Cost metrics rank ascending (cheapest first) and rows with zero of the metric are skipped for them. The right tool for 'which ads should I scale or kill'. Costs 1–2 requests.

CLI: `adside reddit performance rank`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/reddit/performance/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}/reddit/performance/rank:
    post:
      tags:
        - Reddit
      summary: Performance rank
      description: >-
        Rank a dimension (campaigns, ad groups, ads, communities, keywords,
        interests, placements, countries, …) by one metric over a window, with a
        minimum-spend floor. Cost metrics rank ascending (cheapest first) and
        rows with zero of the metric are skipped for them. The right tool for
        'which ads should I scale or kill'. Costs 1–2 requests.


        CLI: `adside reddit performance rank`
      operationId: reddit.rank_reddit_performance
      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:
                ad_account_id:
                  description: >-
                    Reddit ad account id (a2_…). Omit it: it defaults to the ad
                    account this workspace is connected to, and any other
                    account is refused.
                  type: string
                dimension:
                  default: ad
                  description: >-
                    What to rank: campaign, ad_group, ad, community, keyword,
                    interest, placement, country, region, os_type, gender,
                    language.
                  type: string
                metric:
                  default: spend
                  description: >-
                    Metric to rank by. Cost metrics (cpc, ecpm, *_ecpa) rank
                    ascending.
                  type: string
                min_spend:
                  default: 0
                  description: Ignore rows under this spend (account currency).
                  type: number
                  minimum: 0
                top_n:
                  default: 10
                  type: integer
                  minimum: 1
                  maximum: 100
                preset:
                  description: >-
                    Shortcut for a date range. Default last_7d when no
                    start_date/end_date given.
                  type: string
                  enum:
                    - today
                    - yesterday
                    - last_7d
                    - last_14d
                    - last_30d
                    - this_month
                    - last_month
                start_date:
                  description: First day, YYYY-MM-DD, in time_zone_id.
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2}$
                end_date:
                  description: Last day (inclusive), YYYY-MM-DD, in time_zone_id.
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2}$
                time_zone_id:
                  description: >-
                    IANA zone for the date boundaries, e.g. Europe/Paris.
                    Defaults to the ad account's time zone.
                  type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
      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.