> ## Documentation Index
> Fetch the complete documentation index at: https://docs.contentignite.com/llms.txt
> Use this file to discover all available pages before exploring further.

# /report/:id

> The saved set-up of one custom revenue report (fields, filters and date range), not its results



## OpenAPI

````yaml /openapi.json get /v1/report/{id}
openapi: 3.0.1
info:
  title: CI Public API
  description: >-
    # Introduction

    Welcome to the Content Ignite API. A central place for all Content Ignite
    functionality. 


    This API enforces a separation between function and form, meaning anything
    you can do in our platforms can be replicated in your own bespoke solution.


    # Authentication

    Authentication is handled via JWTs. You can retrieve your unique JSON Web
    Token from the settings page in the platform, which needs to be passed in
    with every request.

    To do this, simple include it in an Authorization header with the "Bearer"
    key word.


    Please contact support for help getting started.


    # Error Codes

    This is a fully RESTful API, so prepare for a number of different HTTP
    status codes.


    There is also a standard "success" field returned for each request. This
    boolean value can provide a first check against a response.


    # Rate limit

    We reserve the right to block requests if we deem a client to be abusing the
    API.
  version: 1.0.0
servers:
  - url: https://api.tagdeliver.com
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Reporting
  - name: Reporting/Revenue Reports
  - name: Reporting/Experiment Reporting
  - name: Reporting/Campaign Reports
  - name: Reporting/Health Check
  - name: Reporting/Ads.txt
  - name: Reporting/Utility
  - name: Reporting/Insights Hub
  - name: Reporting/Insights Hub/SSP Insights
  - name: Reporting/Insights Hub/Core Web Vitals
  - name: Reporting/Insights Hub/Ads.txt Insights
  - name: Reporting/Insights Hub/Live Insights
  - name: Reporting/Insights Hub/Metrics
  - name: Reporting/Insights Hub/Diagnostics
  - name: Reporting/Insights Hub/Revenue Insights
  - name: Reporting/Insights Hub/Revenue Analytics
  - name: Reporting/Insights Hub/Demand Mix
  - name: Reporting/Insights Hub/Benchmarking
  - name: Organisation
  - name: Organisation/Organisation Meta
  - name: Organisation/Pricing
  - name: Ad Stack
  - name: Ad Stack/Integration
  - name: Publisher
  - name: Publisher/Publisher Stack
  - name: Publisher/Publisher Tag
  - name: Publisher/Publisher Meta
  - name: Publisher/Experiment
  - name: Publisher/Config (Ad unit)
  - name: Publisher/App Placement
  - name: AI
  - name: AI/Activity
  - name: Billing
  - name: Billing/Invoice
  - name: Audit Log
  - name: '[IN PROGRESS] Integration'
  - name: '[IN PROGRESS] Integration/Mapping'
  - name: '[IN PROGRESS] User'
  - name: '[IN PROGRESS] User/Account'
  - name: public
paths:
  /v1/report/{id}:
    get:
      tags:
        - Reporting/Revenue Reports
        - public
      summary: /report/:id
      description: >-
        The saved set-up of one custom revenue report (fields, filters and date
        range), not its results
      parameters:
        - name: id
          in: path
          description: Unique report ID
          required: true
          example: ''
          schema:
            type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: object
                    properties:
                      id:
                        type: integer
                      title:
                        type: string
                        description: Report name; null when saved without one
                        nullable: true
                      created_by:
                        type: integer
                        description: User id of the creator
                      organisation_id:
                        type: integer
                        description: Organisation that owns the report
                      fields:
                        type: array
                        items:
                          type: string
                          enum:
                            - account_name
                            - account_owner
                            - ad_impressions
                            - ad_requests
                            - ad_responses
                            - ad_unit_loads
                            - campaign_advertiser
                            - campaign
                            - channel
                            - clicks
                            - config_id
                            - config_name
                            - cost
                            - creative_size
                            - ctr
                            - date
                            - device
                            - ecpm
                            - environment
                            - fill
                            - geo
                            - gross_revenue
                            - imp_fill
                            - line_item
                            - month
                            - net_revenue
                            - organisation
                            - page_impressions
                            - page_rpm
                            - partner
                            - platform
                            - publisher
                            - q1_impressions
                            - q1_percent
                            - q2_impressions
                            - q2_percent
                            - q3_impressions
                            - q3_percent
                            - q4_impressions
                            - q4_percent
                            - region
                            - revenue_source
                            - rpm
                            - tag
                            - uid
                            - unit_fill
                            - unit
                            - viewability
                            - viewable_impressions
                        description: >-
                          Dimensions and metrics in the report, in column order.
                          Each becomes a key on the rows from
                          /v1/report/{id}/data
                      date_range:
                        type: string
                        enum:
                          - custom
                          - yesterday
                          - seven_days
                          - thirty_days
                          - three_months
                          - six_months
                          - last_week
                          - last_month
                          - last_quarter
                          - last_year
                          - week_to_date
                          - month_to_date
                          - quarter_to_date
                          - year_to_date
                          - all_time
                        description: >-
                          Saved date range, worked out relative to the day the
                          report runs. `custom` uses custom_date
                      custom_date:
                        type: object
                        description: >-
                          Fixed dates used when date_range is `custom`; null
                          when none were saved
                        properties:
                          start:
                            type: string
                            format: date
                          end:
                            type: string
                            format: date
                        required:
                          - start
                          - end
                        nullable: true
                      filters:
                        description: >-
                          Saved filters keyed by filter name. Option values come
                          from GET /v1/report/filters. A filter with an empty
                          matches list is not applied. An empty array or null
                          when no filters were saved
                        anyOf:
                          - type: object
                            additionalProperties:
                              type: object
                              properties:
                                type:
                                  type: string
                                  enum:
                                    - include
                                    - exclude
                                  description: >-
                                    Keep only matching rows (include) or remove
                                    them (exclude)
                                matches:
                                  type: array
                                  items:
                                    anyOf:
                                      - type: string
                                      - type: number
                            properties:
                              account_name:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: number
                                    description: Integration account ids
                              account_owner:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: number
                                    description: >-
                                      Organisation ids of account owners; 0 is
                                      Content Ignite
                              campaign:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: string
                                    description: Campaign ids, as strings
                              campaign_advertiser:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: string
                                    description: Advertiser names
                              channel:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: string
                              config_id:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: number
                                    description: Ad unit config ids
                              creative_size:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: string
                              device:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: string
                              environment:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: string
                              geo:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: string
                                    description: ISO 3166-1 alpha-2 country codes
                              line_item:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: string
                                    description: Line item ids, as strings
                              oid:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: number
                                    description: Organisation ids
                              partner:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: string
                                    description: Lower-case partner names
                              platform:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: string
                              region:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: string
                                    description: Continent codes
                              revenue_source:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: string
                              tag:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: string
                                    description: Tag slugs
                              uid:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: number
                                    description: Site ids
                              unit:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                      - include
                                      - exclude
                                    description: >-
                                      Keep only matching rows (include) or
                                      remove them (exclude)
                                  matches:
                                    type: array
                                    items:
                                      type: string
                            nullable: true
                          - type: array
                            maxItems: 0
                            items:
                              type: string
                            nullable: true
                      order:
                        type: array
                        description: >-
                          Sort order, first entry sorts first; null when the
                          report has no saved sort
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                              enum:
                                - account_name
                                - account_owner
                                - ad_impressions
                                - ad_requests
                                - ad_responses
                                - ad_unit_loads
                                - campaign_advertiser
                                - campaign
                                - channel
                                - clicks
                                - config_id
                                - config_name
                                - cost
                                - creative_size
                                - ctr
                                - date
                                - device
                                - ecpm
                                - environment
                                - fill
                                - geo
                                - gross_revenue
                                - imp_fill
                                - line_item
                                - month
                                - net_revenue
                                - organisation
                                - page_impressions
                                - page_rpm
                                - partner
                                - platform
                                - publisher
                                - q1_impressions
                                - q1_percent
                                - q2_impressions
                                - q2_percent
                                - q3_impressions
                                - q3_percent
                                - q4_impressions
                                - q4_percent
                                - region
                                - revenue_source
                                - rpm
                                - tag
                                - uid
                                - unit_fill
                                - unit
                                - viewability
                                - viewable_impressions
                              description: One of the report fields
                            sort:
                              type: string
                              enum:
                                - ASC
                                - DESC
                          required:
                            - field
                            - sort
                        nullable: true
                      limit:
                        type: integer
                        description: >-
                          Maximum number of rows the report returns, applied
                          after order; null for no limit
                        nullable: true
                      created_on:
                        type: string
                        description: >-
                          When the report was created, `YYYY-MM-DD HH:MM:SS` in
                          UTC
                      table_state:
                        type: object
                        description: >-
                          Saved table layout from the dashboard (for example
                          columns, sorting, pagination, rowGrouping,
                          aggregation). Stored as sent and not validated; null
                          when none was saved
                        additionalProperties: true
                        properties: {}
                        nullable: true
                      temporary:
                        type: boolean
                        description: >-
                          True for an unsaved report; temporary reports are not
                          listed by GET /v1/report
                    required:
                      - id
                      - title
                      - created_by
                      - organisation_id
                      - fields
                      - date_range
                      - custom_date
                      - filters
                      - order
                      - limit
                      - created_on
                      - table_state
                      - temporary
                  success:
                    type: boolean
                required:
                  - results
                  - success
              example:
                results:
                  id: 4101
                  title: Weekly revenue by site
                  created_by: 2087
                  organisation_id: 312
                  fields:
                    - date
                    - publisher
                    - device
                    - ad_impressions
                    - net_revenue
                  date_range: seven_days
                  custom_date: null
                  filters:
                    device:
                      matches:
                        - mobile
                        - tablet
                      type: include
                    geo:
                      matches:
                        - GB
                      type: exclude
                    tag:
                      matches: []
                      type: include
                    uid:
                      matches:
                        - 18620
                        - 18655
                      type: include
                  order:
                    - field: net_revenue
                      sort: DESC
                  limit: 500
                  created_on: '2026-09-14 09:32:10'
                  table_state:
                    columns:
                      orderedFields:
                        - date
                        - publisher
                        - device
                        - ad_impressions
                        - net_revenue
                    sorting:
                      sortModel:
                        - field: net_revenue
                          sort: desc
                    pagination:
                      pageSize: 50
                      page: 0
                  temporary: false
                success: true
          headers: {}
      deprecated: false
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.