> ## 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/ssp-overview

> Header bidding results across all SSPs for one publisher, compared with similar publishers (its cohort) and the network. For each SSP separately, use `/v1/report/insight/benchmarking/ssps`



## OpenAPI

````yaml /openapi.json get /v1/report/insight/benchmarking/ssp-overview
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/ssp-overview:
    get:
      tags:
        - Reporting/Insights Hub/Benchmarking
        - public
      summary: /report/insight/benchmarking/ssp-overview
      description: >-
        Header bidding results across all SSPs for one publisher, compared with
        similar publishers (its cohort) and the network. For each SSP
        separately, use `/v1/report/insight/benchmarking/ssps`
      parameters:
        - name: uid
          in: query
          description: A single publisher ID
          required: true
          example: ''
          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: rev_type
          in: query
          description: Revenue type
          required: false
          schema:
            type: string
            enum:
              - net
              - gross
            default: gross
        - name: rev_source
          in: query
          description: Revenue source, SaaS or Plug&Play (pap)
          required: false
          schema:
            type: string
            enum:
              - all
              - pap
              - saas
            default: all
        - 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: >-
                          Header bidding totals across all SSPs. Each metric
                          holds the publisher's figure and the per-publisher
                          averages for its cohort and the network; null means no
                          data
                        properties:
                          bid_requests:
                            type: object
                            properties:
                              publisher:
                                type: number
                                nullable: true
                              cohort:
                                type: number
                                nullable: true
                              network:
                                type: number
                                nullable: true
                          bids:
                            type: object
                            properties:
                              publisher:
                                type: number
                                nullable: true
                              cohort:
                                type: number
                                nullable: true
                              network:
                                type: number
                                nullable: true
                          no_bids:
                            type: object
                            properties:
                              publisher:
                                type: number
                                nullable: true
                              cohort:
                                type: number
                                nullable: true
                              network:
                                type: number
                                nullable: true
                          won_bids:
                            type: object
                            properties:
                              publisher:
                                type: number
                                nullable: true
                              cohort:
                                type: number
                                nullable: true
                              network:
                                type: number
                                nullable: true
                          lost_bids:
                            type: object
                            properties:
                              publisher:
                                type: number
                                nullable: true
                              cohort:
                                type: number
                                nullable: true
                              network:
                                type: number
                                nullable: true
                          bid_revenue:
                            type: object
                            description: >-
                              Value of all bids, gross or net following
                              `rev_type`
                            properties:
                              publisher:
                                type: number
                                nullable: true
                              cohort:
                                type: number
                                nullable: true
                              network:
                                type: number
                                nullable: true
                          won_bid_revenue:
                            type: object
                            description: >-
                              Value of winning bids, gross or net following
                              `rev_type`
                            properties:
                              publisher:
                                type: number
                                nullable: true
                              cohort:
                                type: number
                                nullable: true
                              network:
                                type: number
                                nullable: true
                  success:
                    type: boolean
              example:
                results:
                  currency: GBP
                  data:
                    no_bids:
                      publisher: 18420315
                      cohort: 12650480
                      network: 10984210
                    bids:
                      publisher: 6214870
                      cohort: 4102655
                      network: 3577140
                    won_bids:
                      publisher: 1402155
                      cohort: 905330
                      network: 781460
                    bid_requests:
                      publisher: 24635185
                      cohort: 16753135
                      network: 14561350
                    lost_bids:
                      publisher: 4812715
                      cohort: 3197325
                      network: 2795680
                    won_bid_revenue:
                      publisher: 2385.42
                      cohort: 1512
                      network: 1288
                    bid_revenue:
                      publisher: 9874.61
                      cohort: 6240
                      network: 5412
                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.