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

# Active-entities get

> Which entities had any activity (impressions, spend) in a window of up to 90 days, with their activity window and the placements they ran on — the tool to run BEFORE a stats call so you only ask about ids that have data (X: 'you should not request analytics for IDs outside of this set').

CLI: `adside x active-entities get`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/x/active-entities/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/active-entities/get:
    post:
      tags:
        - X
      summary: Active-entities get
      description: >-
        Which entities had any activity (impressions, spend) in a window of up
        to 90 days, with their activity window and the placements they ran on —
        the tool to run BEFORE a stats call so you only ask about ids that have
        data (X: 'you should not request analytics for IDs outside of this
        set').


        CLI: `adside x active-entities get`
      operationId: x.get_x_active_entities
      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:
                    - CAMPAIGN
                    - LINE_ITEM
                    - PROMOTED_TWEET
                    - FUNDING_INSTRUMENT
                    - PROMOTED_ACCOUNT
                    - MEDIA_CREATIVE
                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}$
                campaign_ids:
                  description: Only entities under these campaigns.
                  maxItems: 200
                  type: array
                  items:
                    type: string
                    pattern: ^[0-9a-z]{1,12}$
                line_item_ids:
                  description: Only entities under these line items.
                  maxItems: 200
                  type: array
                  items:
                    type: string
                    pattern: ^[0-9a-z]{1,12}$
      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.