/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

GET /v1/report/insight/benchmarking/ssp-overview

/report/insight/benchmarking/ssp-overview

cURL

curl --request GET \
  --url https://api.tagdeliver.com/v1/report/insight/benchmarking/ssp-overview \
  --header 'Authorization: Bearer <token>'

200

{
  "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
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

uid · integer · required

A single publisher ID

range · enum<string> · default: thirty_days

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

Available options: 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

start · string<date>

Start date when range=custom

end · string<date>

End date when range=custom

rev_type · enum<string> · default: gross

Revenue type

Available options: net, gross

rev_source · enum<string> · default: all

Revenue source, SaaS or Plug&Play (pap)

Available options: all, pap, saas

environment · enum<string> · default: all

Environment or platform to report from

Available options: all, app, web

exclude_pubs · enum<string> · default: no

When yes, leaves out publishers in the same organisation as this publisher, including its child organisations, from the cohort and network

Available options: yes, no

Response

200 - application/json

results · object · required

Show child attributes

success · boolean · required