Day part

This page covers data collection for the Day part variable. See Day part for the corresponding reporting dimension.

The day part variable is the time-of-day bucket when the content was broadcast or played (for example, "Morning", "Afternoon", "Primetime", or "Late Night"). Any string is accepted. Use it to compare engagement across dayparts independent of the viewer’s local time zone.

Web SDK

Set dayPart inside mediaCollection.sessionDetails when calling sendEvent:

alloy("sendEvent", {
  xdm: {
    eventType: "media.sessionStart",
    mediaCollection: {
      sessionDetails: {
        dayPart: "Primetime"
      },
      playhead: 0
    }
  }
});

Mobile SDK

Pass the day part as a metadata key in the HashMap argument to trackSessionStart. Use MediaConstants.VideoMetadataKeys.DAY_PART.

iOS (Swift)

var metadata: [String: String] = [:]
metadata[MediaConstants.VideoMetadataKeys.DAY_PART] = "Primetime"

tracker.trackSessionStart(info: mediaObject, metadata: metadata)

Android (Kotlin)

val metadata = HashMap<String, String>()
metadata[MediaConstants.VideoMetadataKeys.DAY_PART] = "Primetime"

tracker.trackSessionStart(mediaInfo, metadata)

Roku (BrightScript)

Use createMediaSession to set dayPart inside sessionDetails:

m.aepSdk.createMediaSession({
    "xdm": {
        "eventType": "media.sessionStart",
        "mediaCollection": {
            "sessionDetails": {
                "dayPart": "Primetime"
            },
            "playhead": 0
        }
    }
})

Media Edge API

Call the sessionStart endpoint with dayPart inside mediaCollection.sessionDetails:

{
  "events": [{
    "xdm": {
      "eventType": "media.sessionStart",
      "mediaCollection": {
        "sessionDetails": {
          "name": "video-123",
          "length": 128,
          "contentType": "vod",
          "playerName": "HTML5 Player",
          "channel": "Sports",
          "dayPart": "Primetime"
        },
        "playhead": 0
      }
    }
  }]
}

Media SDK

Pass the day part in the contextData object using ADB.Media.VideoMetadataKeys.DayPart:

var contextData = {};
contextData[ADB.Media.VideoMetadataKeys.DayPart] = "Primetime";

tracker.trackSessionStart(mediaInfo, contextData);

Media Collection API

Include media.dayPart in the params object:

{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "sessionStart",
  "params": {
    "media.dayPart": "Primetime"
  }
}

See the Media Collection API sessions reference for the full request structure.