Bids

POST /api

Use this method to get your reporting data of the bids

Headers

Name

Value

Authorization

Basic <token>

Body

{
  table: "bids",
  startDate: string, // (format: YYYY-MM-DDThh:mm:ss)
  endDate: string, // (format: YYYY-MM-DDThh:mm:ss)
  fields: [
    { name: "timestamp", as?: string },
    { name: "account_id", as?: string },
    { name: "account_name", as?: string },
    { name: "site_id", as?: string },
    { name: "site_name", as?: string },
    { name: "tag_id", as?: string },
    { name: "tag_name", as?: string },
    { name: "auction_type", as?: string },
    { name: "mediatype", as?: string },
    { name: "inventory_type", as?: string },
    { name: "os", as?: string },
    { name: "browser", as?: string },
    { name: "device", as?: string },
    { name: "consent", as?: string },
    { name: "domain", as?: string },
    { name: "area", as?: string },
    { name: "ssp", as?: string },
    { name: "ssp_alias", as?: string },
    { name: "classification", as?: string },
    { name: "status", as?: string },
    { name: "buyeruid", as?: string }
  ],
  metrics: [
    { name: "bids", as?: string },
    { name: "auctions", as?: string },
    { name: "bid_net_eur", as?: string },
    { name: "bid_net_usd", as?: string },
    { name: "bid_gross_eur", as?: string },
    { name: "bid_gross_usd", as?: string }
  ],
  timeSplit: "day" | "hour"
}

[
    {
        "timestamp": "2025-06-01T00:00:00.000Z",
        "account_id": 1,
        "account_name": "account_name",
        "site_id": 1,
        "site_name": "site_name",
        "tag_id": "12345678",
        "tag_name": "tag_name",
        "auction_type": "booster",
        "mediatype": "banner",
        "inventory_type": "web",
        "os": "Android",
        "browser": "Chrome",
        "device": "Tablet",
        "consent": true,
        "domain": "domain.com",
        "area": "area",
        "ssp": "ssp",
        "ssp_alias": "ssp_alias",
        "classification": "A",
        "status": "PLAYED",
        "buyeruid": true,
        "bids": "1",
        "auctions": "2",
        "bid_net_eur": 1,
        "bid_net_usd": 2,
        "bid_gross_eur": 3,
        "bid_gross_usd": 4
    }
]

[
    {
        "message": "'unvalid_name' must be equal to one of the allowed values",
        "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"
            ]
        }
    }
]

PreviousAuctions NextIntroduction

Last updated 1 day ago

Was this helpful?

{ table: "bids", startDate: string, // (format: YYYY-MM-DDThh:mm:ss) endDate: string, // (format: YYYY-MM-DDThh:mm:ss) fields: [ { name: "timestamp", as?: string }, { name: "account_id", as?: string }, { name: "account_name", as?: string }, { name: "site_id", as?: string }, { name: "site_name", as?: string }, { name: "tag_id", as?: string }, { name: "tag_name", as?: string }, { name: "auction_type", as?: string }, { name: "mediatype", as?: string }, { name: "inventory_type", as?: string }, { name: "os", as?: string }, { name: "browser", as?: string }, { name: "device", as?: string }, { name: "consent", as?: string }, { name: "domain", as?: string }, { name: "area", as?: string }, { name: "ssp", as?: string }, { name: "ssp_alias", as?: string }, { name: "classification", as?: string }, { name: "status", as?: string }, { name: "buyeruid", as?: string } ], metrics: [ { name: "bids", as?: string }, { name: "auctions", as?: string }, { name: "bid_net_eur", as?: string }, { name: "bid_net_usd", as?: string }, { name: "bid_gross_eur", as?: string }, { name: "bid_gross_usd", as?: string } ], timeSplit: "day" | "hour" }

[ { "timestamp": "2025-06-01T00:00:00.000Z", "account_id": 1, "account_name": "account_name", "site_id": 1, "site_name": "site_name", "tag_id": "12345678", "tag_name": "tag_name", "auction_type": "booster", "mediatype": "banner", "inventory_type": "web", "os": "Android", "browser": "Chrome", "device": "Tablet", "consent": true, "domain": "domain.com", "area": "area", "ssp": "ssp", "ssp_alias": "ssp_alias", "classification": "A", "status": "PLAYED", "buyeruid": true, "bids": "1", "auctions": "2", "bid_net_eur": 1, "bid_net_usd": 2, "bid_gross_eur": 3, "bid_gross_usd": 4 } ]

[ { "message": "'unvalid_name' must be equal to one of the allowed values", "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" ] } } ]