> ## 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/ssp > Header bidding activity and bid revenue by SSP, or by ad unit, config, country or device, with the previous period for comparison ## OpenAPI ````yaml /openapi.json get /v1/report/insight/ssp 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/ssp: get: tags: - Reporting/Insights Hub/SSP Insights - public summary: /report/insight/ssp description: >- Header bidding activity and bid revenue by SSP, or by ad unit, config, country or device, with the previous period for comparison parameters: - name: uid in: query description: >- One or more publisher IDs, comma-separated. Defaults to all publishers in your organisation required: false example: '' schema: type: string - 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. `month_on_month` and `quarter_on_quarter` return monthly or quarterly totals, with the latest period incomplete. `custom` requires `start` and `end` (YYYY-MM-DD). Other values return a 400 error required: false example: '' 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 - 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: date_group in: query description: >- Groups the series by day, month or quarter. `month_on_month` and `quarter_on_quarter` group automatically required: false schema: type: string enum: - day - month - quarter default: day - name: dimension in: query description: >- Breaks the results down by `partner` (SSP), `unit` (ad unit type), `config` (ad unit config), `geo` (country) or `device`. With `partner` and `ssp` set, results are by date instead. Other values return a 400 error required: false example: '' schema: type: string enum: - unit - config - geo - device - partner default: partner - name: rev_type in: query description: Revenue type required: false schema: type: string enum: - gross - net 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: ssp in: query description: SSP to filter on required: false schema: type: string - name: aggregate in: query description: Aggregation method required: false schema: type: string enum: - average - total - name: environment in: query description: Environment or platform to report from required: false schema: type: string enum: - all - app - web default: all responses: '200': description: '' content: application/json: schema: type: object properties: results: type: object properties: currency: type: string description: Currency of the revenue fields dimension: type: array description: >- Labels for the series arrays: dimension values, or dates when results are by date. For dimensions other than `partner`, only the top 15 by won revenue items: type: string bid_opportunity: type: array description: >- Bid requests plus throttled requests, lined up with `dimension` items: type: integer nullable: true bid_request: type: array description: >- Requests sent to the SSP (bids plus no bids), lined up with `dimension` items: type: integer nullable: true bid: type: array description: Bids received, lined up with `dimension` items: type: integer nullable: true bid_won: type: array description: >- Bids that won the impression, lined up with `dimension` items: type: integer nullable: true no_bid: type: array description: >- Requests the SSP didn't bid on, lined up with `dimension` items: type: integer nullable: true bid_lost: type: array description: >- Bids that didn't win (bid minus bid_won), lined up with `dimension` items: type: integer nullable: true bid_throttled: type: array description: >- Requests held back from the SSP by bid throttling, lined up with `dimension` items: type: integer nullable: true bid_revenue: type: array description: Value of all bids, lined up with `dimension` items: type: number nullable: true bid_revenue_won: type: array description: Revenue from winning bids, lined up with `dimension` items: type: number nullable: true stats: type: object description: Totals across every row properties: bid_opportunity: type: integer description: Bid requests plus throttled requests bid_request: type: integer description: Requests sent to the SSP (bids plus no bids) bid: type: integer description: Bids received bid_won: type: integer description: Bids that won the impression no_bid: type: integer description: Requests the SSP didn't bid on bid_lost: type: integer description: Bids that didn't win (bid minus bid_won) bid_throttled: type: integer description: Requests held back from the SSP by bid throttling bid_revenue: type: number description: Value of all bids bid_revenue_won: type: number description: Revenue from winning bids compare: type: object description: Totals for the previous period, without revenue properties: bid_opportunity: type: integer description: Bid requests plus throttled requests nullable: true bid_request: type: integer description: Requests sent to the SSP (bids plus no bids) nullable: true bid: type: integer description: Bids received nullable: true bid_won: type: integer description: Bids that won the impression nullable: true no_bid: type: integer description: Requests the SSP didn't bid on nullable: true bid_lost: type: integer description: Bids that didn't win (bid minus bid_won) nullable: true bid_throttled: type: integer description: >- Requests held back from the SSP by bid throttling nullable: true required: - bid_opportunity - bid_request - bid - bid_won - no_bid - bid_lost - bid_throttled top_performer: type: object description: The row with the most won revenue properties: dimension: type: string description: >- The dimension value, or the period's start date when results are by date bid_opportunity: type: integer description: Bid requests plus throttled requests bid_request: type: integer description: Requests sent to the SSP (bids plus no bids) bid: type: integer description: Bids received bid_won: type: integer description: Bids that won the impression no_bid: type: integer description: Requests the SSP didn't bid on bid_lost: type: integer description: Bids that didn't win (bid minus bid_won) bid_throttled: type: integer description: >- Requests held back from the SSP by bid throttling bid_revenue: type: number description: Value of all bids bid_revenue_won: type: number description: Revenue from winning bids compare: type: object description: >- The same figures for the previous period. Empty when results are by date properties: dimension: type: string description: >- The dimension value, or the period's start date when results are by date bid_opportunity: type: integer description: Bid requests plus throttled requests bid_request: type: integer description: >- Requests sent to the SSP (bids plus no bids) bid: type: integer description: Bids received bid_won: type: integer description: Bids that won the impression no_bid: type: integer description: Requests the SSP didn't bid on bid_lost: type: integer description: Bids that didn't win (bid minus bid_won) bid_throttled: type: integer description: >- Requests held back from the SSP by bid throttling bid_revenue: type: number description: Value of all bids bid_revenue_won: type: number description: Revenue from winning bids required: - dimension - bid_opportunity - bid_request - bid - bid_won - no_bid - bid_lost - bid_throttled - bid_revenue - bid_revenue_won - compare bottom_performer: type: object description: The row with the least won revenue properties: dimension: type: string description: >- The dimension value, or the period's start date when results are by date bid_opportunity: type: integer description: Bid requests plus throttled requests bid_request: type: integer description: Requests sent to the SSP (bids plus no bids) bid: type: integer description: Bids received bid_won: type: integer description: Bids that won the impression no_bid: type: integer description: Requests the SSP didn't bid on bid_lost: type: integer description: Bids that didn't win (bid minus bid_won) bid_throttled: type: integer description: >- Requests held back from the SSP by bid throttling bid_revenue: type: number description: Value of all bids bid_revenue_won: type: number description: Revenue from winning bids compare: type: object description: >- The same figures for the previous period. Empty when results are by date properties: dimension: type: string description: >- The dimension value, or the period's start date when results are by date bid_opportunity: type: integer description: Bid requests plus throttled requests bid_request: type: integer description: >- Requests sent to the SSP (bids plus no bids) bid: type: integer description: Bids received bid_won: type: integer description: Bids that won the impression no_bid: type: integer description: Requests the SSP didn't bid on bid_lost: type: integer description: Bids that didn't win (bid minus bid_won) bid_throttled: type: integer description: >- Requests held back from the SSP by bid throttling bid_revenue: type: number description: Value of all bids bid_revenue_won: type: number description: Revenue from winning bids required: - dimension - bid_opportunity - bid_request - bid - bid_won - no_bid - bid_lost - bid_throttled - bid_revenue - bid_revenue_won - compare required: - bid_opportunity - bid_request - bid - bid_won - no_bid - bid_lost - bid_throttled - bid_revenue - bid_revenue_won - compare - top_performer - bottom_performer data: type: array description: >- Every row, one per dimension value (or per period when results are by date) items: type: object properties: dimension: type: string description: >- The dimension value, or the period's start date when results are by date bid_opportunity: type: integer description: Bid requests plus throttled requests bid_request: type: integer description: Requests sent to the SSP (bids plus no bids) bid: type: integer description: Bids received bid_won: type: integer description: Bids that won the impression no_bid: type: integer description: Requests the SSP didn't bid on bid_lost: type: integer description: Bids that didn't win (bid minus bid_won) bid_throttled: type: integer description: >- Requests held back from the SSP by bid throttling bid_revenue: type: number description: Value of all bids bid_revenue_won: type: number description: Revenue from winning bids required: - dimension - bid_opportunity - bid_request - bid - bid_won - no_bid - bid_lost - bid_throttled - bid_revenue - bid_revenue_won required: - currency - dimension - bid_opportunity - bid_request - bid - bid_won - no_bid - bid_lost - bid_throttled - bid_revenue - bid_revenue_won - stats - data success: type: boolean required: - results - success example: results: currency: GBP dimension: - appnexus - ogury - seedtag bid_opportunity: - 97923881 - 1074 - 102322793 bid_request: - 93708551 - 1074 - 95420679 bid: - 22064472 - 179 - 29643417 bid_won: - 8609531 - 101 - 9904168 no_bid: - 71644079 - 895 - 65777262 bid_lost: - 13454941 - 78 - 19739249 bid_throttled: - 4215330 - 0 - 6902114 bid_revenue: - 18745.82438972 - 0.0767347 - 28961.76876234 bid_revenue_won: - 8365.27115324 - 0.05080034 - 15127.49987196 stats: bid_opportunity: 200247748 bid_request: 189130304 bid: 51708068 bid_won: 18513800 no_bid: 137422236 bid_lost: 33194268 bid_throttled: 11117444 bid_revenue: 47707.66988676 bid_revenue_won: 23492.82182554 compare: bid_opportunity: 174977872 bid_request: 165876986 bid: 38021138 bid_won: 13043056 no_bid: 127855848 bid_lost: 24978082 bid_throttled: 9100886 top_performer: dimension: seedtag bid_opportunity: 102322793 bid_request: 95420679 bid: 29643417 bid_won: 9904168 no_bid: 65777262 bid_lost: 19739249 bid_throttled: 6902114 bid_revenue: 28961.76876234 bid_revenue_won: 15127.49987196 compare: dimension: seedtag bid_opportunity: 84910153 bid_request: 79789379 bid: 18144774 bid_won: 5640853 no_bid: 61644605 bid_lost: 12503921 bid_throttled: 5120774 bid_revenue: 17419.4672116 bid_revenue_won: 8460.67560254 bottom_performer: dimension: ogury bid_opportunity: 1074 bid_request: 1074 bid: 179 bid_won: 101 no_bid: 895 bid_lost: 78 bid_throttled: 0 bid_revenue: 0.0767347 bid_revenue_won: 0.05080034 compare: dimension: ogury bid_opportunity: 972 bid_request: 972 bid: 160 bid_won: 88 no_bid: 812 bid_lost: 72 bid_throttled: 0 bid_revenue: 0.0691201 bid_revenue_won: 0.04412097 data: - dimension: appnexus bid_opportunity: 97923881 bid_request: 93708551 bid: 22064472 bid_won: 8609531 no_bid: 71644079 bid_lost: 13454941 bid_throttled: 4215330 bid_revenue: 18745.82438972 bid_revenue_won: 8365.27115324 - dimension: ogury bid_opportunity: 1074 bid_request: 1074 bid: 179 bid_won: 101 no_bid: 895 bid_lost: 78 bid_throttled: 0 bid_revenue: 0.0767347 bid_revenue_won: 0.05080034 - dimension: seedtag bid_opportunity: 102322793 bid_request: 95420679 bid: 29643417 bid_won: 9904168 no_bid: 65777262 bid_lost: 19739249 bid_throttled: 6902114 bid_revenue: 28961.76876234 bid_revenue_won: 15127.49987196 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.