SSAI Ad tracking log

SSAI Ad tracking log is a new feature that looks to provide details of how SSAI ads are working. This feature is for VOD and Live.

Introduction

Brightcove provides ad tracking logs to help you understand how your SSAI-enabled live streams and videos are performing from a monetization perspective and also to troubleshoot any problems. These logs include the requests to the ad servers: ad requests, errors, and tracking events.

The logs also allow you to calculate performance metrics:

  • Ad Requests: Number of times that an ad server was asked for an ad.
  • Ad Tracking Events fired: number of beacons events fired from BC SSAI server. It can be a breakdown per type: AdStart, AdComplete, AdfirstQuartile, Admidpoint, AdthirdQuartile, AdcreativeView
  • Ad Delivery Rate: the ratio of the total successful ad requests/total of ad requests

Setup

To enable SSAI ad tracking logs, you must do the following:

  1. Create an S3 bucket in your preferred region.
  2. Give Brightcove Support the name of your bucket and the region.
  3. Add the security policy provided to you by Support to enable Brightcove to write to your bucket.
  4. Once the S3 bucket has been set up, to start logging an ad config set ad_tracking_sample_percentage to your Live ad configuration and/or your VOD ad configuration.

File format

The log files will be organized on your S3 bucket according to this schema:

/yyyy/MM/dd/HH/<random-string>/<delivery stream name>-<delivery stream version>-<year>-<month>-<day>-<hour>-<minute>-<second>-<uuid>

<random-string> and </uuid>, will be different for each batch, and the logs are batched in 5MB or 300 seconds of data. Logs for different sessions and jobs will be intermixed in the batches.

Sample path/file

/2021/07/17/00/00HwB2cbPB2/prod-ssai-ad-tracking-4040098940001-1-2021-07-17-00-37-09-caeb9e2e-8b54-42f6-b4f7-cbddfc5090e6

Sample log entries

Below are a few sample log entries.

Sample Log Entry: Creative 
{
  "session_id": "9b393cbf9a4d4528a850c79a283b8b25",
  "summary_id": "adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b-9b393cbf9a4d4528a850c79a283b8b25",
  "adbreak_id": "adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b",
  "account_id": "5100000201001",
  "live_account_id": "e807026ec740429985d04b91cf936f81",
  "live_job_id": "992ab149ce3e40b6a5b9c6d9842a0979",
  "kind": "Creative",
  "timestamp": "2021-06-28T23:12:09.632710435Z",
  "span_id": 3223646445953404770,
  "parent_span_id": 3004116763771491424,
  "state": "active",
  "fk": "ad-id-1",
  "source_url": "https://somesourceasset.com/adcreative.mp4"
}
Sample Log Entry: Ad Request 
{
  "session_id": "9b393cbf9a4d4528a850c79a283b8b25",
  "summary_id": "adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b-9b393cbf9a4d4528a850c79a283b8b25",
  "adbreak_id": "adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b",
  "account_id": "5100000201001",
  "live_account_id": "e807026ec740429985d04b91cf936f81",
  "live_job_id": "992ab149ce3e40b6a5b9c6d9842a0979",
  "kind": "AdRequest",
  "timestamp": "2021-06-28T23:12:09.585696184Z",
  "span_id": 5596747569705325007,
  "parent_span_id": 5124250183191295144,
  "url": "https://ad-provider-host.com/path/to/ad-handler",
  "request_headers": {
    "Referer": [
      "https://referer-host.com"
    ],
    "User-Agent": [
      "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15"
    ],
    "X-Forwarded-For": [
      "127.0.0.1"
    ]
  },
  "response_headers": {
    "Accept-Ranges": [
      "bytes"
    ],
    "Age": [
      "66004"
    ],
    "Connection": [
      "keep-alive"
    ],
    "Content-Length": [
      "1289"
    ],
    "Content-Type": [
      "application/xml"
    ],
    "Date": [
      "Mon, 28 Jun 2021 04:52:06 GMT"
    ],
    "Etag": [
      "\"0801eec0f0f1c1378b409f0b1eaa241e\""
    ],
    "Last-Modified": [
      "Wed, 28 Dec 2016 20:10:29 GMT"
    ],
    "Server": [
      "AmazonS3"
    ],
    "Via": [
      "1.1 56c69262ecfa7873b40572ba8a323243.cloudfront.net (CloudFront)"
    ],
    "X-Amz-Cf-Id": [
      "2SvJiWD30gamE4-w6KL3z9shrGpU2ZAvujfsBTJbC9KSoAy0UDzDBw=="
    ],
    "X-Amz-Cf-Pop": [
      "HIO50-C1"
    ],
    "X-Cache": [
      "Hit from cloudfront"
    ]
  },
  "status_code": 200,
  "duration": 1910203645,
  "provider": "vast_3"
}
Sample Log Entry: Session Summary 
{
  "account_id": "5100000201001",
  "session_id": "9b393cbf9a4d4528a850c79a283b8b25",
  "live_account_id": "e807026ec740429985d04b91cf936f81",
  "live_job_id": "992ab149ce3e40b6a5b9c6d9842a0979",
  "live_app_id": "a51db89789e0413a87ee356bed6965b0",
  "region": "us-west-2",
  "kind": "SessionSummary",
  "duration": 1923000000,
  "status_code": 200,
  "timestamp": "2021-06-28T23:12:11.499Z",
  "adbreak_id": "adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b",
  "summary_id": "adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b-9b393cbf9a4d4528a850c79a283b8b25",
  "odur": 32000000000,
  "rdur": 32000000000,
  "sdur": 34000000000,
  "ad_count": 1,
  "client_only_tracking": false,
  "sls": false,
  "ads": [
    {
      "type": "midroll",
      "fk": "ad-id-1",
      "imps": [
        {
          "type": "AdStart",
          "url": "https://ad-provider-host.com/api/tracking?event=impression"
        },
        {
          "type": "AdFirstQuartile",
          "url": "https://ad-provider-host.com/api/tracking?event=firstQuartile"
        },
        {
          "type": "AdMidpoint",
          "url": "https://ad-provider-host.com/api/tracking?event=midpoint"
        },
        {
          "type": "AdThirdQuartile",
          "url": "https://ad-provider-host.com/api/tracking?event=thirdQuartile"
        },
        {
          "type": "AdComplete",
          "url": "https://ad-provider-host.com/api/tracking?event=complete"
        }
      ],
      "cdur": 30322000000
    }
  ]
}
Sample Log Entry: Impression 
{
  "account_id": "5100000201001",
  "region": "us-west-2",
  "kind": "Impression",
  "impression_type": "AdStart",
  "summary_id": "adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b-9b393cbf9a4d4528a850c79a283b8b25",
  "adbreak_id": "adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b",
  "live_account_id": "e807026ec740429985d04b91cf936f81",
  "live_job_id": "992ab149ce3e40b6a5b9c6d9842a0979",
  "session_id": "9b393cbf9a4d4528a850c79a283b8b25",
  "live_app_id": "a51db89789e0413a87ee356bed6965b0",
  "timestamp": "2021-06-28T23:12:11.499Z",
  "url": "https://ad-provider-host.com/api/tracking?event=impression",
  "request_headers": {
    "Connection": "keep-alive",
    "X-Forwarded-For": "127.0.0.1",
    "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15",
    "Referer": "https://referer-host.com"
  },
  "status_code": 200,
  "duration": 114524248.00000153
}

Full batch

The samples above are separate entries. Brightcove will aggregate these, separated by new lines, and write the aggregated log to your S3 bucket. Below is an example of a full log file.

Sample Full Log File 
{"session_id":"9b393cbf9a4d4528a850c79a283b8b25","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b-9b393cbf9a4d4528a850c79a283b8b25","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b","account_id":"5100000201001","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","kind":"Creative","timestamp":"2021-06-28T23:12:09.632710435Z","span_id":3223646445953404770,"parent_span_id":3004116763771491424,"state":"active","fk":"ad-id-1","source_url":"https://somesourceasset.com/adcreative.mp4"}
  {"session_id":"9b393cbf9a4d4528a850c79a283b8b25","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b-9b393cbf9a4d4528a850c79a283b8b25","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b","account_id":"5100000201001","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","kind":"AdRequest","timestamp":"2021-06-28T23:12:09.585696184Z","span_id":5596747569705325007,"parent_span_id":5124250183191295144,"url":"https://ad-provider-host.com/path/to/ad-handler","request_headers":{"Referer":["https://referer-host.com"],"User-Agent":["Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15"],"X-Forwarded-For":["127.0.0.1"]},"response_headers":{"Accept-Ranges":["bytes"],"Age":["66004"],"Connection":["keep-alive"],"Content-Length":["1289"],"Content-Type":["application/xml"],"Date":["Mon, 28 Jun 2021 04:52:06 GMT"],"Etag":["\"0801eec0f0f1c1378b409f0b1eaa241e\""],"Last-Modified":["Wed, 28 Dec 2016 20:10:29 GMT"],"Server":["AmazonS3"],"Via":["1.1 56c69262ecfa7873b40572ba8a323243.cloudfront.net (CloudFront)"],"X-Amz-Cf-Id":["2SvJiWD30gamE4-w6KL3z9shrGpU2ZAvujfsBTJbC9KSoAy0UDzDBw=="],"X-Amz-Cf-Pop":["HIO50-C1"],"X-Cache":["Hit from cloudfront"]},"status_code":200,"duration":1910203645,"provider":"vast_3"}
  {"account_id":"5100000201001","session_id":"9b393cbf9a4d4528a850c79a283b8b25","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","live_app_id":"a51db89789e0413a87ee356bed6965b0","region":"us-west-2","kind":"SessionSummary","duration":1923000000,"status_code":200,"timestamp":"2021-06-28T23:12:11.499Z","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b-9b393cbf9a4d4528a850c79a283b8b25","odur":32000000000,"rdur":32000000000,"sdur":34000000000,"ad_count":1,"client_only_tracking":false,"sls":false,"ads":[{"type":"midroll","fk":"ad-id-1","imps":[{"type":"AdStart","url":"https://ad-provider-host.com/api/tracking?event=impression"},{"type":"AdFirstQuartile","url":"https://ad-provider-host.com/api/tracking?event=firstQuartile"},{"type":"AdMidpoint","url":"https://ad-provider-host.com/api/tracking?event=midpoint"},{"type":"AdThirdQuartile","url":"https://ad-provider-host.com/api/tracking?event=thirdQuartile"},{"type":"AdComplete","url":"https://ad-provider-host.com/api/tracking?event=complete"}],"cdur":30322000000}]}
  {"account_id":"5100000201001","region":"us-west-2","kind":"Impression","impression_type":"AdStart","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b-9b393cbf9a4d4528a850c79a283b8b25","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","session_id":"9b393cbf9a4d4528a850c79a283b8b25","live_app_id":"a51db89789e0413a87ee356bed6965b0","timestamp":"2021-06-28T23:12:11.499Z","url":"https://ad-provider-host.com/api/tracking?event=impression","request_headers":{"Connection":"keep-alive","X-Forwarded-For":"127.0.0.1","User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15","Referer":"https://referer-host.com"},"status_code":200,"duration":114524248.00000153}
  {"account_id":"5100000201001","region":"us-west-2","kind":"Impression","impression_type":"AdFirstQuartile","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b-9b393cbf9a4d4528a850c79a283b8b25","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","session_id":"9b393cbf9a4d4528a850c79a283b8b25","live_app_id":"a51db89789e0413a87ee356bed6965b0","timestamp":"2021-06-28T23:12:11.501Z","url":"https://ad-provider-host.com/api/tracking?event=firstQuartile","request_headers":{"Connection":"keep-alive","X-Forwarded-For":"127.0.0.1","User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15","Referer":"https://referer-host.com"},"status_code":200,"duration":94157248.00014868}
  {"account_id":"5100000201001","region":"us-west-2","kind":"Impression","impression_type":"AdMidpoint","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b-9b393cbf9a4d4528a850c79a283b8b25","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","session_id":"9b393cbf9a4d4528a850c79a283b8b25","live_app_id":"a51db89789e0413a87ee356bed6965b0","timestamp":"2021-06-28T23:12:11.502Z","url":"https://ad-provider-host.com/api/tracking?event=midpoint","request_headers":{"Connection":"keep-alive","X-Forwarded-For":"127.0.0.1","User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15","Referer":"https://referer-host.com"},"status_code":200,"duration":9150570.999830961}
  {"account_id":"5100000201001","region":"us-west-2","kind":"Impression","impression_type":"AdThirdQuartile","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b-9b393cbf9a4d4528a850c79a283b8b25","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","session_id":"9b393cbf9a4d4528a850c79a283b8b25","live_app_id":"a51db89789e0413a87ee356bed6965b0","timestamp":"2021-06-28T23:12:11.503Z","url":"https://ad-provider-host.com/api/tracking?event=thirdQuartile","request_headers":{"Connection":"keep-alive","X-Forwarded-For":"127.0.0.1","User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15","Referer":"https://referer-host.com"},"status_code":200,"duration":13312409.999780357}
  {"account_id":"5100000201001","region":"us-west-2","kind":"Impression","impression_type":"AdComplete","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b-9b393cbf9a4d4528a850c79a283b8b25","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-0e96c29df5214a4195e7e94f9cf90c8b","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","session_id":"9b393cbf9a4d4528a850c79a283b8b25","live_app_id":"a51db89789e0413a87ee356bed6965b0","timestamp":"2021-06-28T23:12:11.504Z","url":"https://ad-provider-host.com/api/tracking?event=complete","request_headers":{"Connection":"keep-alive","X-Forwarded-For":"127.0.0.1","User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15","Referer":"https://referer-host.com"},"status_code":200,"duration":12268809.00003016}
  {"session_id":"9b393cbf9a4d4528a850c79a283b8b25","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-522e68923faf435ebc5710ec9ba12f8c-9b393cbf9a4d4528a850c79a283b8b25","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-522e68923faf435ebc5710ec9ba12f8c","account_id":"5100000201001","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","kind":"Creative","timestamp":"2021-06-28T23:14:35.099703094Z","span_id":6674394482725440815,"parent_span_id":1318535851542687167,"state":"active","fk":"ad-id-1","source_url":"https://somesourceasset.com/adcreative.mp4"}
  {"session_id":"9b393cbf9a4d4528a850c79a283b8b25","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-522e68923faf435ebc5710ec9ba12f8c-9b393cbf9a4d4528a850c79a283b8b25","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-522e68923faf435ebc5710ec9ba12f8c","account_id":"5100000201001","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","kind":"AdRequest","timestamp":"2021-06-28T23:14:35.037747217Z","span_id":879241329021924545,"parent_span_id":2738404345413976285,"url":"https://ad-provider-host.com/path/to/ad-handler","request_headers":{"Referer":["https://referer-host.com"],"User-Agent":["Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15"],"X-Forwarded-For":["127.0.0.1"]},"response_headers":{"Accept-Ranges":["bytes"],"Age":["66150"],"Connection":["keep-alive"],"Content-Length":["1289"],"Content-Type":["application/xml"],"Date":["Mon, 28 Jun 2021 04:52:06 GMT"],"Etag":["\"0801eec0f0f1c1378b409f0b1eaa241e\""],"Last-Modified":["Wed, 28 Dec 2016 20:10:29 GMT"],"Server":["AmazonS3"],"Via":["1.1 1b0911478686968732f973d6e5e31d11.cloudfront.net (CloudFront)"],"X-Amz-Cf-Id":["gwjYU97w_Ko7_VOEJo_I7mQIia4aUxI6NhpL79QBwcGovwgqsiQQ2Q=="],"X-Amz-Cf-Pop":["HIO50-C1"],"X-Cache":["Hit from cloudfront"]},"status_code":200,"duration":62517876,"provider":"vast_3"}
  {"account_id":"5100000201001","session_id":"9b393cbf9a4d4528a850c79a283b8b25","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","live_app_id":"a51db89789e0413a87ee356bed6965b0","region":"us-west-2","kind":"SessionSummary","duration":74000000,"status_code":200,"timestamp":"2021-06-28T23:14:35.103Z","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-522e68923faf435ebc5710ec9ba12f8c","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-522e68923faf435ebc5710ec9ba12f8c-9b393cbf9a4d4528a850c79a283b8b25","odur":32000000000,"rdur":32000000000,"sdur":34000000000,"ad_count":1,"client_only_tracking":false,"sls":false,"ads":[{"type":"midroll","fk":"ad-id-1","imps":[{"type":"AdStart","url":"https://ad-provider-host.com/api/tracking?event=impression"},{"type":"AdFirstQuartile","url":"https://ad-provider-host.com/api/tracking?event=firstQuartile"},{"type":"AdMidpoint","url":"https://ad-provider-host.com/api/tracking?event=midpoint"},{"type":"AdThirdQuartile","url":"https://ad-provider-host.com/api/tracking?event=thirdQuartile"},{"type":"AdComplete","url":"https://ad-provider-host.com/api/tracking?event=complete"}],"cdur":30322000000}]}
  {"account_id":"5100000201001","region":"us-west-2","kind":"Impression","impression_type":"AdStart","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-522e68923faf435ebc5710ec9ba12f8c-9b393cbf9a4d4528a850c79a283b8b25","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-522e68923faf435ebc5710ec9ba12f8c","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","session_id":"9b393cbf9a4d4528a850c79a283b8b25","live_app_id":"a51db89789e0413a87ee356bed6965b0","timestamp":"2021-06-28T23:14:35.104Z","url":"https://ad-provider-host.com/api/tracking?event=impression","request_headers":{"Connection":"keep-alive","X-Forwarded-For":"127.0.0.1","User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15","Referer":"https://referer-host.com"},"status_code":200,"duration":68253645.00004798}
  {"account_id":"5100000201001","region":"us-west-2","kind":"Impression","impression_type":"AdFirstQuartile","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-522e68923faf435ebc5710ec9ba12f8c-9b393cbf9a4d4528a850c79a283b8b25","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-522e68923faf435ebc5710ec9ba12f8c","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","session_id":"9b393cbf9a4d4528a850c79a283b8b25","live_app_id":"a51db89789e0413a87ee356bed6965b0","timestamp":"2021-06-28T23:14:35.105Z","url":"https://ad-provider-host.com/api/tracking?event=firstQuartile","request_headers":{"Connection":"keep-alive","X-Forwarded-For":"127.0.0.1","User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15","Referer":"https://referer-host.com"},"status_code":200,"duration":73142498.99983406}
  {"account_id":"5100000201001","region":"us-west-2","kind":"Impression","impression_type":"AdMidpoint","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-522e68923faf435ebc5710ec9ba12f8c-9b393cbf9a4d4528a850c79a283b8b25","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-522e68923faf435ebc5710ec9ba12f8c","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","session_id":"9b393cbf9a4d4528a850c79a283b8b25","live_app_id":"a51db89789e0413a87ee356bed6965b0","timestamp":"2021-06-28T23:14:35.106Z","url":"https://ad-provider-host.com/api/tracking?event=midpoint","request_headers":{"Connection":"keep-alive","X-Forwarded-For":"127.0.0.1","User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15","Referer":"https://referer-host.com"},"status_code":200,"duration":7360496.000153944}
  {"account_id":"5100000201001","region":"us-west-2","kind":"Impression","impression_type":"AdThirdQuartile","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-522e68923faf435ebc5710ec9ba12f8c-9b393cbf9a4d4528a850c79a283b8b25","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-522e68923faf435ebc5710ec9ba12f8c","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","session_id":"9b393cbf9a4d4528a850c79a283b8b25","live_app_id":"a51db89789e0413a87ee356bed6965b0","timestamp":"2021-06-28T23:14:35.107Z","url":"https://ad-provider-host.com/api/tracking?event=thirdQuartile","request_headers":{"Connection":"keep-alive","X-Forwarded-For":"127.0.0.1","User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15","Referer":"https://referer-host.com"},"status_code":200,"duration":15530145.999975502}
  {"account_id":"5100000201001","region":"us-west-2","kind":"Impression","impression_type":"AdComplete","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-522e68923faf435ebc5710ec9ba12f8c-9b393cbf9a4d4528a850c79a283b8b25","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-522e68923faf435ebc5710ec9ba12f8c","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","session_id":"9b393cbf9a4d4528a850c79a283b8b25","live_app_id":"a51db89789e0413a87ee356bed6965b0","timestamp":"2021-06-28T23:14:35.108Z","url":"https://ad-provider-host.com/api/tracking?event=complete","request_headers":{"Connection":"keep-alive","X-Forwarded-For":"127.0.0.1","User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15","Referer":"https://referer-host.com"},"status_code":200,"duration":18099798.00018482}
  {"session_id":"3799e473b53d47c1a4aba1a96282ae63","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-f1eb781318d847eea4941009c37fd115-3799e473b53d47c1a4aba1a96282ae63","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-f1eb781318d847eea4941009c37fd115","account_id":"5100000201001","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","kind":"Creative","timestamp":"2021-06-28T23:17:50.848526142Z","span_id":1072414950932142870,"parent_span_id":3759119308175968927,"state":"active","fk":"ad-id-1","source_url":"https://somesourceasset.com/adcreative.mp4"}
  {"session_id":"3799e473b53d47c1a4aba1a96282ae63","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-f1eb781318d847eea4941009c37fd115-3799e473b53d47c1a4aba1a96282ae63","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-f1eb781318d847eea4941009c37fd115","account_id":"5100000201001","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","kind":"AdRequest","timestamp":"2021-06-28T23:17:50.803309913Z","span_id":5501083171814814828,"parent_span_id":2777154131847882503,"url":"https://ad-provider-host.com/path/to/ad-handler","request_headers":{"Referer":["https://referer-host.com"],"User-Agent":["Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15"],"X-Forwarded-For":["127.0.0.1"]},"response_headers":{"Accept-Ranges":["bytes"],"Age":["66345"],"Connection":["keep-alive"],"Content-Length":["1289"],"Content-Type":["application/xml"],"Date":["Mon, 28 Jun 2021 04:52:06 GMT"],"Etag":["\"0801eec0f0f1c1378b409f0b1eaa241e\""],"Last-Modified":["Wed, 28 Dec 2016 20:10:29 GMT"],"Server":["AmazonS3"],"Via":["1.1 1cc6ed0d2d3dd9529ce544f9dfe61a53.cloudfront.net (CloudFront)"],"X-Amz-Cf-Id":["6ChJOWTNhXQ54nrI-0NfiI3HELyzVmDKFmi-6JhCYyzzcnh-FejM5A=="],"X-Amz-Cf-Pop":["HIO50-C1"],"X-Cache":["Hit from cloudfront"]},"status_code":200,"duration":463516026,"provider":"vast_3"}
  {"account_id":"5100000201001","session_id":"3799e473b53d47c1a4aba1a96282ae63","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","live_app_id":"a51db89789e0413a87ee356bed6965b0","region":"us-west-2","kind":"SessionSummary","duration":481000000,"status_code":200,"timestamp":"2021-06-28T23:17:51.274Z","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-f1eb781318d847eea4941009c37fd115","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-f1eb781318d847eea4941009c37fd115-3799e473b53d47c1a4aba1a96282ae63","odur":32000000000,"rdur":32000000000,"sdur":34000000000,"ad_count":1,"client_only_tracking":false,"sls":false,"ads":[{"type":"midroll","fk":"ad-id-1","imps":[{"type":"AdStart","url":"https://ad-provider-host.com/api/tracking?event=impression"},{"type":"AdFirstQuartile","url":"https://ad-provider-host.com/api/tracking?event=firstQuartile"},{"type":"AdMidpoint","url":"https://ad-provider-host.com/api/tracking?event=midpoint"},{"type":"AdThirdQuartile","url":"https://ad-provider-host.com/api/tracking?event=thirdQuartile"},{"type":"AdComplete","url":"https://ad-provider-host.com/api/tracking?event=complete"}],"cdur":30322000000}]}
  {"account_id":"5100000201001","region":"us-west-2","kind":"Impression","impression_type":"AdStart","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-f1eb781318d847eea4941009c37fd115-3799e473b53d47c1a4aba1a96282ae63","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-f1eb781318d847eea4941009c37fd115","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","session_id":"3799e473b53d47c1a4aba1a96282ae63","live_app_id":"a51db89789e0413a87ee356bed6965b0","timestamp":"2021-06-28T23:17:51.276Z","url":"https://ad-provider-host.com/api/tracking?event=impression","request_headers":{"Connection":"keep-alive","X-Forwarded-For":"127.0.0.1","User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15","Referer":"https://referer-host.com"},"status_code":200,"duration":100628732.00001195}
  {"account_id":"5100000201001","region":"us-west-2","kind":"Impression","impression_type":"AdFirstQuartile","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-f1eb781318d847eea4941009c37fd115-3799e473b53d47c1a4aba1a96282ae63","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-f1eb781318d847eea4941009c37fd115","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","session_id":"3799e473b53d47c1a4aba1a96282ae63","live_app_id":"a51db89789e0413a87ee356bed6965b0","timestamp":"2021-06-28T23:17:51.277Z","url":"https://ad-provider-host.com/api/tracking?event=firstQuartile","request_headers":{"Connection":"keep-alive","X-Forwarded-For":"127.0.0.1","User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15","Referer":"https://referer-host.com"},"status_code":200,"duration":72044457.99998939}
  {"account_id":"5100000201001","region":"us-west-2","kind":"Impression","impression_type":"AdMidpoint","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-f1eb781318d847eea4941009c37fd115-3799e473b53d47c1a4aba1a96282ae63","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-f1eb781318d847eea4941009c37fd115","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","session_id":"3799e473b53d47c1a4aba1a96282ae63","live_app_id":"a51db89789e0413a87ee356bed6965b0","timestamp":"2021-06-28T23:17:51.278Z","url":"https://ad-provider-host.com/api/tracking?event=midpoint","request_headers":{"Connection":"keep-alive","X-Forwarded-For":"127.0.0.1","User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15","Referer":"https://referer-host.com"},"status_code":200,"duration":7449264.000169933}
  {"account_id":"5100000201001","region":"us-west-2","kind":"Impression","impression_type":"AdThirdQuartile","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-f1eb781318d847eea4941009c37fd115-3799e473b53d47c1a4aba1a96282ae63","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-f1eb781318d847eea4941009c37fd115","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","session_id":"3799e473b53d47c1a4aba1a96282ae63","live_app_id":"a51db89789e0413a87ee356bed6965b0","timestamp":"2021-06-28T23:17:51.279Z","url":"https://ad-provider-host.com/api/tracking?event=thirdQuartile","request_headers":{"Connection":"keep-alive","X-Forwarded-For":"127.0.0.1","User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15","Referer":"https://referer-host.com"},"status_code":200,"duration":7948938.000015914}
  {"account_id":"5100000201001","region":"us-west-2","kind":"Impression","impression_type":"AdComplete","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-f1eb781318d847eea4941009c37fd115-3799e473b53d47c1a4aba1a96282ae63","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-f1eb781318d847eea4941009c37fd115","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","session_id":"3799e473b53d47c1a4aba1a96282ae63","live_app_id":"a51db89789e0413a87ee356bed6965b0","timestamp":"2021-06-28T23:17:51.280Z","url":"https://ad-provider-host.com/api/tracking?event=complete","request_headers":{"Connection":"keep-alive","X-Forwarded-For":"127.0.0.1","User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15","Referer":"https://referer-host.com"},"status_code":200,"duration":9952213.999815285}
  {"session_id":"3799e473b53d47c1a4aba1a96282ae63","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-20063d6dae794906af1251c6948400db-3799e473b53d47c1a4aba1a96282ae63","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-20063d6dae794906af1251c6948400db","account_id":"5100000201001","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","kind":"Creative","timestamp":"2021-06-28T23:21:31.192038303Z","span_id":2134906764417527191,"parent_span_id":8679583036437874814,"state":"active","fk":"ad-id-1","source_url":"https://somesourceasset.com/adcreative.mp4"}
  {"session_id":"3799e473b53d47c1a4aba1a96282ae63","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-20063d6dae794906af1251c6948400db-3799e473b53d47c1a4aba1a96282ae63","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-20063d6dae794906af1251c6948400db","account_id":"5100000201001","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","kind":"AdRequest","timestamp":"2021-06-28T23:21:31.154993034Z","span_id":8570463038803610161,"parent_span_id":3420437761948447498,"url":"https://ad-provider-host.com/path/to/ad-handler","request_headers":{"Referer":["https://referer-host.com"],"User-Agent":["Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15"],"X-Forwarded-For":["127.0.0.1"]},"response_headers":{"Accept-Ranges":["bytes"],"Age":["66566"],"Connection":["keep-alive"],"Content-Length":["1289"],"Content-Type":["application/xml"],"Date":["Mon, 28 Jun 2021 04:52:06 GMT"],"Etag":["\"0801eec0f0f1c1378b409f0b1eaa241e\""],"Last-Modified":["Wed, 28 Dec 2016 20:10:29 GMT"],"Server":["AmazonS3"],"Via":["1.1 41e349e25dc4bc856d0e5d2c162428a0.cloudfront.net (CloudFront)"],"X-Amz-Cf-Id":["PdYetvq3mfyZyeYyzW4zBsRGTaopewgHBTkDGKU3d4CgwrKATC8HYQ=="],"X-Amz-Cf-Pop":["HIO50-C1"],"X-Cache":["Hit from cloudfront"]},"status_code":200,"duration":37220442,"provider":"vast_3"}
  {"account_id":"5100000201001","session_id":"3799e473b53d47c1a4aba1a96282ae63","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","live_app_id":"a51db89789e0413a87ee356bed6965b0","region":"us-west-2","kind":"SessionSummary","duration":51000000,"status_code":200,"timestamp":"2021-06-28T23:21:31.195Z","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-20063d6dae794906af1251c6948400db","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-20063d6dae794906af1251c6948400db-3799e473b53d47c1a4aba1a96282ae63","odur":32000000000,"rdur":32000000000,"sdur":34000000000,"ad_count":1,"client_only_tracking":false,"sls":false,"ads":[{"type":"midroll","fk":"ad-id-1","imps":[{"type":"AdStart","url":"https://ad-provider-host.com/api/tracking?event=impression"},{"type":"AdFirstQuartile","url":"https://ad-provider-host.com/api/tracking?event=firstQuartile"},{"type":"AdMidpoint","url":"https://ad-provider-host.com/api/tracking?event=midpoint"},{"type":"AdThirdQuartile","url":"https://ad-provider-host.com/api/tracking?event=thirdQuartile"},{"type":"AdComplete","url":"https://ad-provider-host.com/api/tracking?event=complete"}],"cdur":30322000000}]}
  {"account_id":"5100000201001","region":"us-west-2","kind":"Impression","impression_type":"AdStart","summary_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-20063d6dae794906af1251c6948400db-3799e473b53d47c1a4aba1a96282ae63","adbreak_id":"adBreak-992ab149ce3e40b6a5b9c6d9842a0979-20063d6dae794906af1251c6948400db","live_account_id":"e807026ec740429985d04b91cf936f81","live_job_id":"992ab149ce3e40b6a5b9c6d9842a0979","session_id":"3799e473b53d47c1a4aba1a96282ae63","live_app_id":"a51db89789e0413a87ee356bed6965b0","timestamp":"2021-06-28T23:21:31.197Z","url":"https://ad-provider-host.com/api/tracking?event=impression","request_headers":{"Connection":"keep-alive","X-Forwarded-For":"127.0.0.1","User-Agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15","Referer":"https://referer-host.com"},"status_code":200,"duration":106990529.99960259}

Log fields

Common fields

All log types share these fields.

Common fields
Field Type Description
session_id string Session ID. Unique per viewer.
summary_id string Session Summary ID. For VOD, same as SessionID. For Live, unique per Session per Ad Break.
adbreak_id string Ad Break ID. Unique per Ad Break
account_id string Video Cloud account ID.
live_account_id string live account ID.
video_id string Video Cloud video ID.
live_job_id string Live job ID.
live_app_id string Live SSAI application ID.
title_id string VOD title id.
kind string Log Kind for this log. Creative, AdRequest, SessionSummary, or Impression.
timestamp string Timestamp of log. Marshalled into RFC3339 format. e.g. "2021-06-03T11:39:22.787Z".
span_id unit64 SpanID is a trace ID for this log.
parent_span_id unit64 ParentSpanID references a SpanID of a parent log. This value can be useful for following the chain of VAST wrapper calls.
error boolean True if there was an error associated with this log. Its meaning depends on the log Kind.

HTTP fields

These fields are shared among log Kinds that are for HTTP requests made to external services like an ad provider.

Log Kinds that have HTTP fields are:

HTTP Fields
Field Type Description
url string Request URL.
request_headers map[string][]string Headers sent in the request. Map with header names for keys and list of strings for header values.
response_headers map[string][]string Headers received in response. Map with header names for keys and list of strings for header values.
status_code integer Response status code.
duration integer64 Duration of request in nanoseconds.

SessionSummary fields

Contains a summary of ad insertions for the session.

Includes Common fields.

SessionSummary fields
Field Type Description
odur integer64 OriginalDuration of ads intended to be inserted. Value is in nanoseconds.
rdur integer64 RequestedDuration may differ from OriginalDuration in live streams depending on when the session connects during an ad break. e.g. session joins 10s into 30s adbreak, Live will request 20s of ads (odur=30,rdur=20). Value is in nanoseconds.
sdur integer64 SubstitutedDuration is the duration of live chunks substituted with ads. This value could differ from OriginalDuration depending on the duration of ads returned from provider and if slate was inserted.
ad_count integer Number of ads inserted.
ads []AdSummary List of summaries about each ad inserted.
sls boolean SLS is true if the ad break has live SLS enabled.
client_only_tracking boolean ClientOnlyTracking is true if the ad break has live client only tracking enabled.

AdSummary fields

AdSummary fields
Field Type Description
imps []ImpressionSummary
fk string Foreign Key of the creative for this ad.
type string Ad type. e.g. preroll, midroll, etc.
cdur integer64 CreativeDuration is the duration of this ad. Value is in nanoseconds.

ImpressionSummary fields

ImpressionSummary fields
Field Type Description
type string Impression type. AdStart, AdComplete, AdFirstQuartile, AdMidpoint, or AdThirdQuartile.
url string URL to send impression to.

AdRequest fields

Contains HTTP request and response data with Ad Provider.

Includes Common fields and HTTP Fields

AdRequest fields
Field Type Description
provider string Ad Provider type. e.g. vast3, vmap, etc.

Creative fields

Contains information about the ad creative from the ad provider.

Includes Common fields.

Creative fields
Field Type Description
state string State of the creative at time of request.

Values for VOD:

  • active - creative is active
  • missing_fk - foreign key was not present on ad
  • missing_url - URL was not present on ad
  • internal_error - internal error while processing creative
  • no_title_id - failed to get title for ad
  • title_metadata_error - error while processing title for ad
  • rendition_mismatch - there is a mismatch in bitrates or aspect ratios between the content and the ad
fk string Foreign Key for creative.
record_id string Used by VOD.
source_url string Source URL of the creative.

Impression fields

All log types share these fields.

Includes Common fields and HTTP fields.

Impression fields
Field Type Description
impression_type string Impression type. e.g. AdStart, AdComplete, etc.