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

# Stats get

> Synchronous performance stats for up to 20 entities over at most 7 days (X's caps): any entity level, friendly metric names or X metric groups, DAY / HOUR / TOTAL granularity, one placement. Money is converted from X's micros; derived metrics (CPM, CPE, CTR, …) are computed here from X's formulas. Longer windows go through `adside x stats-job create`. Run `adside x active-entities get` first so you only ask about ids that had activity. Costs 1–3 requests.

CLI: `adside x stats get`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/x/stats/get
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}/x/stats/get:
    post:
      tags:
        - X
      summary: Stats get
      description: >-
        Synchronous performance stats for up to 20 entities over at most 7 days
        (X's caps): any entity level, friendly metric names or X metric groups,
        DAY / HOUR / TOTAL granularity, one placement. Money is converted from
        X's micros; derived metrics (CPM, CPE, CTR, …) are computed here from
        X's formulas. Longer windows go through `adside x stats-job create`. Run
        `adside x active-entities get` first so you only ask about ids that had
        activity. Costs 1–3 requests.


        CLI: `adside x stats get`
      operationId: x.get_x_stats
      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:
                account_id:
                  description: >-
                    X ads account id (e.g. 18ce55xcrlv). Omit it: it defaults to
                    the ads account this workspace is connected to, and any
                    other account is refused.
                  type: string
                entity:
                  default: CAMPAIGN
                  type: string
                  enum:
                    - ACCOUNT
                    - FUNDING_INSTRUMENT
                    - CAMPAIGN
                    - LINE_ITEM
                    - PROMOTED_TWEET
                    - PROMOTED_ACCOUNT
                    - MEDIA_CREATIVE
                entity_ids:
                  description: >-
                    Up to 20 ids of that entity (X's cap). For ACCOUNT omit it.
                    Omit for CAMPAIGN / LINE_ITEM / PROMOTED_TWEET to use the
                    entities active in the window (from `adside x
                    active-entities get`, first 20).
                  maxItems: 20
                  type: array
                  items:
                    type: string
                    minLength: 1
                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 the account's time zone.
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2}$
                end_date:
                  description: >-
                    Last day (inclusive), YYYY-MM-DD, in the account's time
                    zone. The exclusive end X wants is computed for you.
                  type: string
                  pattern: ^\d{4}-\d{2}-\d{2}$
                granularity:
                  default: DAY
                  description: >-
                    DAY buckets are midnight-to-midnight in the account's time
                    zone; HOUR is hourly; TOTAL is one bucket.
                  type: string
                  enum:
                    - DAY
                    - HOUR
                    - TOTAL
                placement:
                  default: ALL_ON_TWITTER
                  type: string
                  enum:
                    - ALL_ON_TWITTER
                    - PUBLISHER_NETWORK
                    - SPOTLIGHT
                    - TREND
                  description: >-
                    One placement per stats request (X accepts a single value).
                    Default ALL_ON_TWITTER; other placements are separate calls.
                metrics:
                  description: >-
                    Friendly metric names: spend, impressions, engagements,
                    clicks, url_clicks, likes, follows, video_total_views,
                    conversion_purchases, … plus derived ones (cpm, cpe, cplc,
                    ctr, engagement_rate, cpv, cpa, roas) computed here.
                    Default: the ENGAGEMENT + BILLING groups. See `adside x
                    metrics list`.
                  type: array
                  items:
                    type: string
                metric_groups:
                  description: >-
                    X metric groups to request. MOBILE_CONVERSION must be
                    requested alone.
                  type: array
                  items:
                    type: string
                    enum:
                      - ENGAGEMENT
                      - BILLING
                      - VIDEO
                      - WEB_CONVERSION
                      - MOBILE_CONVERSION
                      - LIFE_TIME_VALUE_MOBILE_CONVERSION
                format:
                  default: markdown
                  description: json only when fields must be reused programmatically.
                  type: string
                  enum:
                    - markdown
                    - json
      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.