Auctions

POST /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: "consent", as?: string },
    { name: "tag_id", as?: string },
    { name: "site_id", as?: string },
    { name: "account_id", as?: string },
    { name: "tag_name", as?: string },
    { name: "site_name", as?: string },
    { name: "account_name", as?: string },
    { name: "os", as?: string },
    { name: "browser", as?: string },
    { name: "device", as?: string },
    { name: "country", as?: string }
  ],
  metrics: [
    { name: "auctions", as?: string },
    { name: "impressions", as?: string }
  ],
  timeSplit: "day" | "hour"
}

200 Valid Request

[
    {
        "timestamp": "2025-06-01T00:00:00.000Z",
        "tag_id": "tag_id",
        "tag_name": "tag_name",
        "site_id": 1,
        "site_name": "site_name",
        "account_id": 1,
        "account_name": "account_name Advertising",
        "auction_type": "booster",
        "mediatype": "banner",
        "os": "Android",
        "browser": "Chrome",
        "device": "Tablet",
        "country": "country",
        "auctions": "1",
        "impressions": "1"
    }
]

401 Unauthorized

Unauthorized

400 Bad Request

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