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

# Insights get

> LIVE performance insights straight from the Meta Graph API (impressions, clicks, spend, CTR, CPC, actions, conversions) for a campaign, ad set, ad, or account. Meta reports some results only in `conversions` (such as `start_trial_total`), so a result missing from `actions` is not proof that Meta credits none. If you pass `fields`, include both. Supports date presets, custom date ranges, breakdowns, and custom field selection. For pixel/dataset event activity independent of ad attribution or ad-set attachment, use `adside meta pixel-stats get`; these insights cannot establish whether a pixel receives events.

If reporting-warehouse tools are available to you in this session (`get_top_creatives_data`, `get_campaign_spend`, `get_account_summary`, `query_reporting`), this tool is the fallback, not the default. Use it only for what the warehouse cannot answer: today and the last 24h, or a breakdown it does not carry. Ranking ads or campaigns over a past period ('which ads should I kill/scale', 'top creatives'), multi-day totals, and week- or month-over-month trends all belong to the warehouse — it aggregates in SQL, answers for every object in one call, and returns a ranked handful of rows instead of one row per object.

This tool returns one raw JSON row per object per time bucket, each carrying full `actions`, `cost_per_action_type` and `conversions` arrays. At `level: 'ad'` over a multi-day range that is tens of thousands of tokens — enough to fill your context and truncate your own answer. If you call it anyway, narrow it: the smallest `limit` that answers the question, an explicit `fields` list, and one call with `time_increment` rather than one call per period.

The response is capped in size. Past that, rows are dropped and a `truncation` object says how many — the rows you get back are an arbitrary page, NOT the top performers, because this endpoint returns no ranking. `summary` is always computed over every fetched row, so totals and averages stay correct even when rows are dropped. If you see `truncation`, do not rank from what remains: ask the warehouse.

CLI: `adside meta insights get`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/meta/insights/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}/meta/insights/get:
    post:
      tags:
        - Meta
      summary: Insights get
      description: >-
        LIVE performance insights straight from the Meta Graph API (impressions,
        clicks, spend, CTR, CPC, actions, conversions) for a campaign, ad set,
        ad, or account. Meta reports some results only in `conversions` (such as
        `start_trial_total`), so a result missing from `actions` is not proof
        that Meta credits none. If you pass `fields`, include both. Supports
        date presets, custom date ranges, breakdowns, and custom field
        selection. For pixel/dataset event activity independent of ad
        attribution or ad-set attachment, use `adside meta pixel-stats get`;
        these insights cannot establish whether a pixel receives events.


        If reporting-warehouse tools are available to you in this session
        (`get_top_creatives_data`, `get_campaign_spend`, `get_account_summary`,
        `query_reporting`), this tool is the fallback, not the default. Use it
        only for what the warehouse cannot answer: today and the last 24h, or a
        breakdown it does not carry. Ranking ads or campaigns over a past period
        ('which ads should I kill/scale', 'top creatives'), multi-day totals,
        and week- or month-over-month trends all belong to the warehouse — it
        aggregates in SQL, answers for every object in one call, and returns a
        ranked handful of rows instead of one row per object.


        This tool returns one raw JSON row per object per time bucket, each
        carrying full `actions`, `cost_per_action_type` and `conversions`
        arrays. At `level: 'ad'` over a multi-day range that is tens of
        thousands of tokens — enough to fill your context and truncate your own
        answer. If you call it anyway, narrow it: the smallest `limit` that
        answers the question, an explicit `fields` list, and one call with
        `time_increment` rather than one call per period.


        The response is capped in size. Past that, rows are dropped and a
        `truncation` object says how many — the rows you get back are an
        arbitrary page, NOT the top performers, because this endpoint returns no
        ranking. `summary` is always computed over every fetched row, so totals
        and averages stay correct even when rows are dropped. If you see
        `truncation`, do not rank from what remains: ask the warehouse.


        CLI: `adside meta insights get`
      operationId: meta.get_insights
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                object_id:
                  description: >-
                    ID of the object to get insights for. Omit it to use the
                    connected ad account (recommended for account-wide queries
                    at any level). Otherwise pass a campaign ID, ad set ID, or
                    ad ID matching `level`. Account IDs other than the connected
                    account are rejected. Passing a page/business/user ID
                    returns Meta error #100.
                  type: string
                level:
                  type: string
                  enum:
                    - account
                    - campaign
                    - adset
                    - ad
                  description: Level of insights to retrieve
                date_preset:
                  description: Date preset for insights
                  type: string
                  enum:
                    - today
                    - yesterday
                    - last_3d
                    - last_7d
                    - last_14d
                    - last_28d
                    - last_30d
                    - last_90d
                    - this_week_mon_today
                    - this_week_sun_today
                    - last_week_mon_sun
                    - last_week_sun_sat
                    - this_month
                    - last_month
                    - this_quarter
                    - last_quarter
                    - this_year
                    - last_year
                    - maximum
                    - data_maximum
                time_range:
                  description: Custom date range for insights
                  type: object
                  properties:
                    since:
                      type: string
                      pattern: ^\d{4}-\d{2}-\d{2}$
                      description: Start date (YYYY-MM-DD)
                    until:
                      type: string
                      pattern: ^\d{4}-\d{2}-\d{2}$
                      description: End date (YYYY-MM-DD)
                  required:
                    - since
                    - until
                fields:
                  description: >-
                    Specific fields to retrieve (e.g., impressions, clicks,
                    spend)
                  type: array
                  items:
                    type: string
                breakdowns:
                  description: Breakdown dimensions (e.g., age, gender, placement)
                  type: array
                  items:
                    type: string
                time_increment:
                  description: >-
                    Time granularity: "monthly" for monthly rows, "all_days" for
                    daily rows, or a number 1-90 for N-day increments
                  anyOf:
                    - type: string
                      enum:
                        - monthly
                        - all_days
                    - type: integer
                      minimum: 1
                      maximum: 90
                limit:
                  default: 25
                  description: Number of insights to return
                  type: number
                  minimum: 1
                  maximum: 100
                after:
                  description: >-
                    Cursor for the next page: pass back the
                    `pagination.next_cursor` value from a previous response.
                    Keep every other parameter identical, or the cursor no
                    longer matches the query it came from.
                  type: string
              required:
                - level
      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.