> ## 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/insight/benchmarking/revenue-dimension

> Programmatic revenue benchmarks for one publisher, broken down by one dimension such as country, device or partner



## OpenAPI

````yaml /openapi.json get /v1/report/insight/benchmarking/revenue-dimension
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/insight/benchmarking/revenue-dimension:
    get:
      tags:
        - Reporting/Insights Hub/Benchmarking
        - public
      summary: /report/insight/benchmarking/revenue-dimension
      description: >-
        Programmatic revenue benchmarks for one publisher, broken down by one
        dimension such as country, device or partner
      parameters:
        - name: uid
          in: query
          description: A single publisher ID
          required: true
          schema:
            deprecated: false
            type: integer
        - name: range
          in: query
          description: >-
            Date range to report on. Preset ranges end yesterday.
            `month_to_date` is the current month so far and `week_to_date` is
            the current week so far. `custom` requires `start` and `end`
            (YYYY-MM-DD). Other values return a 400 error
          required: false
          schema:
            type: string
            enum:
              - custom
              - all_time
              - seven_days
              - fourteen_days
              - thirty_days
              - three_months
              - six_months
              - week_to_date
              - month_to_date
              - quarter_to_date
              - year_to_date
              - last_week
              - last_month
              - last_quarter
              - last_year
              - month_on_month
              - quarter_on_quarter
              - yesterday
            default: thirty_days
        - name: start
          in: query
          description: Start date when range=custom
          required: false
          schema:
            type: string
            format: date
        - name: end
          in: query
          description: End date when range=custom
          required: false
          schema:
            type: string
            format: date
        - name: dimension
          in: query
          description: The dimension to report on
          required: false
          schema:
            type: string
            enum:
              - ad_unit_type
              - geo
              - region
              - device
              - channel
              - partner
              - creative_size
            default: geo
        - name: environment
          in: query
          description: Environment or platform to report from
          required: false
          schema:
            type: string
            enum:
              - all
              - app
              - web
            default: all
        - name: exclude_pubs
          in: query
          description: >-
            When `yes`, leaves out publishers in the same organisation as this
            publisher, including its child organisations, from the cohort and
            network
          required: false
          schema:
            type: string
            enum:
              - 'yes'
              - 'no'
            default: 'no'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                required:
                  - results
                  - success
                properties:
                  results:
                    type: object
                    required:
                      - currency
                      - data
                    properties:
                      currency:
                        type: string
                        description: Currency code all revenue is converted to
                      data:
                        type: object
                        description: >-
                          One entry per dimension value, keyed by that value
                          (for example a country name, region name or device).
                          Missing values come back as unknown. Each metric holds
                          the publisher's figure and the per-publisher averages
                          for its cohort and the network; null means no data
                        additionalProperties:
                          type: object
                          properties:
                            gross_revenue:
                              type: object
                              properties:
                                publisher:
                                  type: number
                                  nullable: true
                                cohort:
                                  type: number
                                  nullable: true
                                network:
                                  type: number
                                  nullable: true
                            pap_gross_revenue:
                              type: object
                              properties:
                                publisher:
                                  type: number
                                  nullable: true
                                cohort:
                                  type: number
                                  nullable: true
                                network:
                                  type: number
                                  nullable: true
                            saas_gross_revenue:
                              type: object
                              properties:
                                publisher:
                                  type: number
                                  nullable: true
                                cohort:
                                  type: number
                                  nullable: true
                                network:
                                  type: number
                                  nullable: true
                            net_revenue:
                              type: object
                              properties:
                                publisher:
                                  type: number
                                  nullable: true
                                cohort:
                                  type: number
                                  nullable: true
                                network:
                                  type: number
                                  nullable: true
                            pap_net_revenue:
                              type: object
                              properties:
                                publisher:
                                  type: number
                                  nullable: true
                                cohort:
                                  type: number
                                  nullable: true
                                network:
                                  type: number
                                  nullable: true
                            saas_net_revenue:
                              type: object
                              properties:
                                publisher:
                                  type: number
                                  nullable: true
                                cohort:
                                  type: number
                                  nullable: true
                                network:
                                  type: number
                                  nullable: true
                            impressions:
                              type: object
                              properties:
                                publisher:
                                  type: number
                                  nullable: true
                                cohort:
                                  type: number
                                  nullable: true
                                network:
                                  type: number
                                  nullable: true
                            pap_impressions:
                              type: object
                              properties:
                                publisher:
                                  type: number
                                  nullable: true
                                cohort:
                                  type: number
                                  nullable: true
                                network:
                                  type: number
                                  nullable: true
                            saas_impressions:
                              type: object
                              properties:
                                publisher:
                                  type: number
                                  nullable: true
                                cohort:
                                  type: number
                                  nullable: true
                                network:
                                  type: number
                                  nullable: true
                        properties: {}
                  success:
                    type: boolean
              example:
                results:
                  currency: GBP
                  data:
                    desktop:
                      gross_revenue:
                        publisher: 8412.37
                        cohort: 6120.84
                        network: 5233.19
                      pap_gross_revenue:
                        publisher: 5888.66
                        cohort: 4102.5
                        network: 3561.07
                      saas_gross_revenue:
                        publisher: 2523.71
                        cohort: 2018.34
                        network: 1672.12
                      net_revenue:
                        publisher: 6729.9
                        cohort: 4896.67
                        network: 4186.55
                      pap_net_revenue:
                        publisher: 4710.93
                        cohort: 3282
                        network: 2848.86
                      saas_net_revenue:
                        publisher: 2018.97
                        cohort: 1614.67
                        network: 1337.69
                      impressions:
                        publisher: 3164800
                        cohort: 2401350.5
                        network: 2087412.25
                      pap_impressions:
                        publisher: 2215360
                        cohort: 1609904.75
                        network: 1420440.5
                      saas_impressions:
                        publisher: 949440
                        cohort: 791445.75
                        network: 666971.75
                    mobile:
                      gross_revenue:
                        publisher: 13102.44
                        cohort: 9874.12
                        network: 8410.66
                      pap_gross_revenue:
                        publisher: 9171.71
                        cohort: 6911.88
                        network: 5887.46
                      saas_gross_revenue:
                        publisher: 3930.73
                        cohort: 2962.24
                        network: 2523.2
                      net_revenue:
                        publisher: 10481.95
                        cohort: 7899.3
                        network: 6728.53
                      pap_net_revenue:
                        publisher: 7337.37
                        cohort: 5529.5
                        network: 4709.97
                      saas_net_revenue:
                        publisher: 3144.58
                        cohort: 2369.8
                        network: 2018.56
                      impressions:
                        publisher: 6029100
                        cohort: 4718842.25
                        network: 4102877.5
                      pap_impressions:
                        publisher: 4220370
                        cohort: 3303189.5
                        network: 2872014.25
                      saas_impressions:
                        publisher: 1808730
                        cohort: 1415652.75
                        network: 1230863.25
                    tablet:
                      gross_revenue:
                        publisher: null
                        cohort: 412.9
                        network: 366.08
                      pap_gross_revenue:
                        publisher: null
                        cohort: 289.03
                        network: 256.26
                      saas_gross_revenue:
                        publisher: null
                        cohort: 123.87
                        network: 109.82
                      net_revenue:
                        publisher: null
                        cohort: 330.32
                        network: 292.86
                      pap_net_revenue:
                        publisher: null
                        cohort: 231.22
                        network: 205
                      saas_net_revenue:
                        publisher: null
                        cohort: 99.1
                        network: 87.86
                      impressions:
                        publisher: null
                        cohort: 191210.5
                        network: 170044
                      pap_impressions:
                        publisher: null
                        cohort: 133847.25
                        network: 119030.75
                      saas_impressions:
                        publisher: null
                        cohort: 57363.25
                        network: 51013.25
                    unknown:
                      gross_revenue:
                        publisher: 37.42
                        cohort: 21.86
                        network: 18.3
                      pap_gross_revenue:
                        publisher: 26.19
                        cohort: 15.3
                        network: 12.81
                      saas_gross_revenue:
                        publisher: 11.23
                        cohort: 6.56
                        network: 5.49
                      net_revenue:
                        publisher: 29.94
                        cohort: 17.49
                        network: 14.64
                      pap_net_revenue:
                        publisher: 20.95
                        cohort: 12.24
                        network: 10.25
                      saas_net_revenue:
                        publisher: 8.99
                        cohort: 5.25
                        network: 4.39
                      impressions:
                        publisher: 18630
                        cohort: 11204.75
                        network: 9512.5
                      pap_impressions:
                        publisher: 13041
                        cohort: 7843.25
                        network: 6658.75
                      saas_impressions:
                        publisher: 5589
                        cohort: 3361.5
                        network: 2853.75
                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.