Auctions
POST /v2/api
Use this method to get your reporting data of the auctions
Headers
Name
Value
Authorization
Basic <token>
Body
{
table: "auctions",
startDate: string, // (format: YYYY-MM-DDThh:mm:ss)
endDate: string, // (format: YYYY-MM-DDThh:mm:ss)
fields: [
{ name: "timestamp", as?: string },
{ name: "auction_type", as?: string },
{ name: "mediatype", as?: string },
{ name: "inventory_type", as?: string },
{ name: "tag_id", as?: string },
{ name: "tag_name", as?: string },
{ name: "site_id", as?: string },
{ name: "site_name", as?: string },
{ name: "account_id", as?: string },
{ name: "account_name", as?: string },
{ name: "sub_account_id", as?: string },
{ name: "sub_account_name", as?: string },
{ name: "device", as?: string },
{ name: "ssp", as?: string },
{ name: "ssp_alias", as?: string },
{ name: "placement", as?: string },
{ name: "consent", as?: string },
{ name: "os", as?: string },
{ name: "browser", as?: string },
{ name: "country", as?: string },
{ name: "domain", as?: string },
{ name: "area", as?: string },
{ name: "customid", as?: string },
{ name: "gpid", as?: string }
],
metrics: [
{ name: "auctions", as?: string },
{ name: "impressions", as?: string },
{ name: "revenue_net_eur", as?: string },
{ name: "revenue_net_usd", as?: string },
{ name: "revenue_gross_eur", as?: string },
{ name: "revenue_gross_usd", as?: string },
{ name: "won", as?: string },
{ name: "won_net_eur", as?: string },
{ name: "won_net_usd", as?: string },
{ name: "won_gross_eur", as?: string },
{ name: "won_gross_usd", as?: string }
],
timeSplit: "day"
}{
table: "auctions",
startDate: string, // (format: YYYY-MM-DDThh:mm:ss)
endDate: string, // (format: YYYY-MM-DDThh:mm:ss)
fields: [
{ name: "timestamp", as?: string },
{ name: "auction_type", as?: string },
{ name: "mediatype", as?: string },
{ name: "inventory_type", as?: string },
{ name: "tag_id", as?: string },
{ name: "tag_name", as?: string },
{ name: "site_id", as?: string },
{ name: "site_name", as?: string },
{ name: "account_id", as?: string },
{ name: "account_name", as?: string },
{ name: "sub_account_id", as?: string },
{ name: "sub_account_name", as?: string },
{ name: "device", as?: string },
{ name: "ssp", as?: string },
{ name: "ssp_alias", as?: string },
{ name: "placement", as?: string }
],
metrics: [
{ name: "auctions", as?: string },
{ name: "impressions", as?: string },
{ name: "revenue_net_eur", as?: string },
{ name: "revenue_net_usd", as?: string },
{ name: "revenue_gross_eur", as?: string },
{ name: "revenue_gross_usd", as?: string },
{ name: "won", as?: string },
{ name: "won_net_eur", as?: string },
{ name: "won_net_usd", as?: string },
{ name: "won_gross_eur", as?: string },
{ name: "won_gross_usd", as?: string }
],
timeSplit: "hour"
}[
{
"timestamp": "2025-12-01T00:00:00.000Z",
"auction_type": "booster",
"mediatype": "banner",
"inventory_type": "web",
"tag_id": "tag_abc123",
"tag_name": "Homepage Banner",
"site_id": 5001,
"site_name": "example-site.com",
"account_id": 1067,
"account_name": "Nexx360 Demo",
"sub_account_id": 2001,
"sub_account_name": "Sub Account Demo",
"device": "Desktop",
"ssp": "rubicon",
"ssp_alias": "Rubicon Project",
"placement": "sidebar",
"consent": true,
"os": "Windows",
"browser": "Firefox",
"country": "DE",
"domain": "example-site.com",
"area": "eu-central",
"customid": "custom_abc",
"gpid": "/12345/sidebar/banner",
"auctions": "250000",
"impressions": "18500",
"revenue_net_eur": 185.25,
"revenue_net_usd": 203.78,
"revenue_gross_eur": 222.30,
"revenue_gross_usd": 244.53,
"won": "19200",
"won_net_eur": 192.00,
"won_net_usd": 211.20,
"won_gross_eur": 230.40,
"won_gross_usd": 253.44
}
][
{
"message": "'unvalid_name' must be equal to one of the allowed values for table 'auctions'",
"params": {
"allowedValues": [
"timestamp",
"account_id",
"account_name",
"site_id",
"site_name",
"tag_id",
"tag_name",
"auction_type",
"mediatype",
"inventory_type",
"os",
"browser",
"device",
"ssp",
"ssp_alias",
"size",
"consent",
"buyeruid",
"domain",
"adomain",
"deal_external_id",
"country"
]
}
}
]Last updated
Was this helpful?