Viewed
POST /v2/api
Use this method to get your reporting data of the Viewed
Headers
Name
Value
Authorization
Basic <token>
Body
{
table: "viewed",
startDate: string, // (format: YYYY-MM-DDThh:mm:ss)
endDate: string, // (format: YYYY-MM-DDThh:mm:ss)
fields: [
{ name: "timestamp", 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: "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: "seat", as?: string },
{ name: "bid_classification", as?: string },
{ name: "is_safeframe", as?: string },
{ name: "placement", as?: string },
{ name: "os", as?: string },
{ name: "browser", as?: string },
{ name: "country", as?: string },
{ name: "area", as?: string },
{ name: "domain", as?: string },
{ name: "adomain", as?: string },
{ name: "size", as?: string },
{ name: "consent", as?: string },
{ name: "buyeruid", as?: string },
{ name: "customid", as?: string },
{ name: "gpid", as?: string }
],
metrics: [
{ name: "views", as?: string }
],
timeSplit: "day"
}{
table: "viewed",
startDate: string, // (format: YYYY-MM-DDThh:mm:ss)
endDate: string, // (format: YYYY-MM-DDThh:mm:ss)
fields: [
{ name: "timestamp", 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: "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: "seat", as?: string },
{ name: "bid_classification", as?: string },
{ name: "is_safeframe", as?: string },
{ name: "placement", as?: string }
],
metrics: [
{ name: "views", as?: string }
],
timeSplit: "hour"
}[
{
"timestamp": "2025-12-01T00:00:00.000Z",
"tag_id": "tag_view_001",
"tag_name": "Viewability Banner",
"site_id": 5003,
"site_name": "news-site.com",
"account_id": 1067,
"account_name": "Nexx360 Demo",
"sub_account_id": 2003,
"sub_account_name": "News Sub Account",
"auction_type": "dynamic",
"mediatype": "banner",
"inventory_type": "web",
"device": "Desktop",
"ssp": "index",
"ssp_alias": "Index Exchange",
"deal_external_id": "deal_view_456",
"seat": "seat_view_001",
"bid_classification": "standard",
"is_safeframe": true,
"placement": "above_fold",
"os": "macOS",
"browser": "Safari",
"country": "FR",
"area": "eu-west",
"domain": "news-site.com",
"adomain": "brand-advertiser.com",
"size": "728x90",
"consent": true,
"buyeruid": true,
"customid": "custom_view",
"gpid": "/news/above_fold/leaderboard",
"views": "28500"
}
][
{
"message": "'unvalid_name' must be equal to one of the allowed values for table 'vast_events'",
"params": {
"allowedValues": [
"timestamp",
"auction_type",
"tag_id",
"site_id",
"account_id",
"tag_name",
"site_name",
"account_name",
"os",
"browser",
"device",
"country",
"ssp",
"seat",
"domain",
"adomain",
"deal"
]
}
}
]Last updated
Was this helpful?