> ## 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/ssps

> Header bidding results per SSP for one publisher (bid rate, win rate and bid value), compared with similar publishers (its cohort) and the network



## OpenAPI

````yaml /openapi.json get /v1/report/insight/benchmarking/ssps
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/ssps:
    get:
      tags:
        - Reporting/Insights Hub/Benchmarking
        - public
      summary: /report/insight/benchmarking/ssps
      description: >-
        Header bidding results per SSP for one publisher (bid rate, win rate and
        bid value), compared with similar publishers (its cohort) and the
        network
      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: 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: >-
                          One entry per SSP, keyed by SSP code. Bids with no SSP
                          recorded come back as unknown. Includes SSPs used by
                          the cohort or network but not this publisher, with
                          null publisher values. Each metric holds the
                          publisher's figure and the per-publisher averages for
                          its cohort and the network among publishers using that
                          SSP
                        additionalProperties:
                          type: object
                          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
                        properties: {}
                  success:
                    type: boolean
              example:
                results:
                  currency: GBP
                  data:
                    appnexus:
                      no_bids:
                        publisher: 6120450
                        cohort: 4210380
                        network: 3655120
                      bids:
                        publisher: 2240310
                        cohort: 1480215
                        network: 1290440
                      won_bids:
                        publisher: 512880
                        cohort: 330910
                        network: 285300
                      bid_requests:
                        publisher: 8360760
                        cohort: 5690595
                        network: 4945560
                      lost_bids:
                        publisher: 1727430
                        cohort: 1149305
                        network: 1005140
                      won_bid_revenue:
                        publisher: 874.36
                        cohort: 552
                        network: 471
                      bid_revenue:
                        publisher: 3610.92
                        cohort: 2288
                        network: 1984
                    rubicon:
                      no_bids:
                        publisher: 7480215
                        cohort: 5102440
                        network: 4418230
                      bids:
                        publisher: 2614980
                        cohort: 1730120
                        network: 1508860
                      won_bids:
                        publisher: 601455
                        cohort: 388760
                        network: 335910
                      bid_requests:
                        publisher: 10095195
                        cohort: 6832560
                        network: 5927090
                      lost_bids:
                        publisher: 2013525
                        cohort: 1341360
                        network: 1172950
                      won_bid_revenue:
                        publisher: 1048.57
                        cohort: 661
                        network: 566
                      bid_revenue:
                        publisher: 4205.48
                        cohort: 2657
                        network: 2303
                    pubmatic:
                      no_bids:
                        publisher: null
                        cohort: 2804215
                        network: 2490380
                      bids:
                        publisher: null
                        cohort: 902140
                        network: 795520
                      won_bids:
                        publisher: null
                        cohort: 186250
                        network: 162740
                      bid_requests:
                        publisher: null
                        cohort: 3706355
                        network: 3285900
                      lost_bids:
                        publisher: null
                        cohort: 715890
                        network: 632780
                      won_bid_revenue:
                        publisher: null
                        cohort: 301
                        network: 262
                      bid_revenue:
                        publisher: null
                        cohort: 1295
                        network: 1124
                    unknown:
                      no_bids:
                        publisher: 41210
                        cohort: 28650
                        network: 24180
                      bids:
                        publisher: 6420
                        cohort: 4180
                        network: 3650
                      won_bids:
                        publisher: 1310
                        cohort: 860
                        network: 740
                      bid_requests:
                        publisher: 47630
                        cohort: 32830
                        network: 27830
                      lost_bids:
                        publisher: 5110
                        cohort: 3320
                        network: 2910
                      won_bid_revenue:
                        publisher: 2.18
                        cohort: 1
                        network: 1
                      bid_revenue:
                        publisher: 9.47
                        cohort: 6
                        network: 5
                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.