Impressions
POST /v2/api
Use this method to get your reporting data of the impressions
Headers
Name
Value
Authorization
Basic <token>
Body
{
table: "impressions",
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: "sub_account_id", as?: string },
{ name: "sub_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: "device", as?: string },
{ name: "ssp", as?: string },
{ name: "ssp_alias", as?: string },
{ name: "deal_external_id", as?: string },
{ name: "placement", as?: string },
{ name: "os", as?: string },
{ name: "browser", as?: string },
{ name: "size", as?: string },
{ name: "consent", as?: string },
{ name: "buyeruid", as?: string },
{ name: "domain", as?: string },
{ name: "adomain", as?: string },
{ name: "country", as?: string },
{ name: "area", as?: string },
{ name: "seat", as?: string },
{ name: "customid", as?: string },
{ name: "gpid", as?: string }
],
metrics: [
{ 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 }
],
timeSplit: "day" | "hour"
}{
table: "impressions",
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: "sub_account_id", as?: string },
{ name: "sub_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: "device", as?: string },
{ name: "ssp", as?: string },
{ name: "ssp_alias", as?: string },
{ name: "deal_external_id", as?: string },
{ name: "placement", as?: string }
],
metrics: [
{ 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 }
],
timeSplit: "hour"
}[
{
"timestamp": "2025-12-01T00:00:00.000Z",
"account_id": 1067,
"account_name": "Nexx360 Demo",
"sub_account_id": 2001,
"sub_account_name": "Sub Account Demo",
"site_id": 5001,
"site_name": "example-site.com",
"tag_id": "tag_abc123",
"tag_name": "Homepage Banner",
"auction_type": "booster",
"mediatype": "banner",
"inventory_type": "web",
"device": "Mobile",
"ssp": "appnexus",
"ssp_alias": "AppNexus Display",
"deal_external_id": "deal_12345",
"placement": "top_banner",
"os": "Android",
"browser": "Chrome",
"size": "300x250",
"consent": true,
"buyeruid": true,
"domain": "example-site.com",
"adomain": "advertiser.com",
"country": "FR",
"area": "eu-west",
"seat": "seat_001",
"customid": "custom_xyz",
"gpid": "/12345/homepage/banner",
"impressions": "15420",
"revenue_net_eur": 125.50,
"revenue_net_usd": 138.05,
"revenue_gross_eur": 150.60,
"revenue_gross_usd": 165.66
}
][
{
"message": "'unvalid_name' must be equal to one of the allowed values for table 'impressions'",
"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?