Vast Events
POST /v2/api
Use this method to get your reporting data of the Vast events
Headers
Name
Value
Authorization
Basic <token>
Body
{
table: "vast_events",
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: "placement", as?: string },
{ name: "vast_error", as?: string },
{ name: "os", as?: string },
{ name: "browser", as?: string },
{ name: "country", as?: string },
{ name: "domain", as?: string },
{ name: "adomain", as?: string },
{ name: "customid", as?: string },
{ name: "gpid", as?: string }
],
metrics: [
{ name: "impression", as?: string },
{ name: "vast_error", as?: string },
{ name: "events", as?: string },
{ name: "start", as?: string },
{ name: "firstquartile", as?: string },
{ name: "midpoint", as?: string },
{ name: "thirdquartile", as?: string },
{ name: "complete", as?: string },
{ name: "creativeview", as?: string },
{ name: "passback", as?: string },
{ name: "empty", as?: string },
{ name: "click", as?: string },
{ name: "error", as?: string }
],
timeSplit: "day"
}{
table: "vast_events",
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: "placement", as?: string },
{ name: "vast_error", as?: string }
],
metrics: [
{ name: "impression", as?: string },
{ name: "vast_error", as?: string },
{ name: "events", as?: string },
{ name: "start", as?: string },
{ name: "firstquartile", as?: string },
{ name: "midpoint", as?: string },
{ name: "thirdquartile", as?: string },
{ name: "complete", as?: string },
{ name: "creativeview", as?: string },
{ name: "passback", as?: string },
{ name: "empty", as?: string },
{ name: "click", as?: string },
{ name: "error", as?: string }
],
timeSplit: "hour"
}[
{
"timestamp": "2025-12-01T00:00:00.000Z",
"tag_id": "tag_video_001",
"tag_name": "Preroll Video",
"site_id": 5002,
"site_name": "video-site.com",
"account_id": 1067,
"account_name": "Nexx360 Demo",
"sub_account_id": 2002,
"sub_account_name": "Video Sub Account",
"auction_type": "booster",
"mediatype": "video",
"inventory_type": "web",
"device": "CTV",
"ssp": "spotx",
"ssp_alias": "SpotX Video",
"deal_external_id": "deal_video_123",
"seat": "seat_video_001",
"placement": "preroll",
"vast_error": "0",
"os": "tvOS",
"browser": "Native",
"country": "UK",
"domain": "video-site.com",
"adomain": "video-advertiser.com",
"customid": "custom_video",
"gpid": "/video/preroll/001",
"impression": "45000",
"events": "180000",
"start": "44500",
"firstquartile": "42000",
"midpoint": "39500",
"thirdquartile": "37000",
"complete": "35000",
"creativeview": "44800",
"passback": "200",
"empty": "150",
"click": "1250",
"error": "300"
}
][
{
"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?