DocumentationAnalyticsStreaming media services guide

Season

Last update: May 28, 2026

CREATED FOR:

  • Developer

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

style
shade-box

The season variable is the season number for the show (typically a string integer like "2"). Set it for content that is part of a series so engagement can be broken out by season. Pair with Show and Episode for full episodic context.

Property
Value
Context data variable
a.media.season
XDM collection field
xdm.mediaCollection.sessionDetails.season
Audience Manager trait
c_contextdata.a.media.season
Required
No
Sent with
Session start, session close
Web SDK

Set season inside xdm.mediaCollection.sessionDetails when calling sendEvent:

code language-javascript 
alloy("sendEvent", {
  xdm: {
    eventType: "media.sessionStart",
    mediaCollection: {
      sessionDetails: {
        season: "2"
      },
      playhead: 0
    }
  }
});
iOS

Pass the season as a metadata key in the HashMap argument to trackSessionStart. Use MediaConstants.VideoMetadataKeys.SEASON.

code language-swift 
var metadata: [String: String] = [:]
metadata[MediaConstants.VideoMetadataKeys.SEASON] = "2"

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

Pass the season as a metadata key in the HashMap argument to trackSessionStart. Use MediaConstants.VideoMetadataKeys.SEASON.

code language-kotlin 
val metadata = HashMap<String, String>()
metadata[MediaConstants.VideoMetadataKeys.SEASON] = "2"

tracker.trackSessionStart(mediaInfo, metadata)
Roku

Use createMediaSession to set season inside sessionDetails:

code language-brightscript 
m.aepSdk.createMediaSession({
    "xdm": {
        "eventType": "media.sessionStart",
        "mediaCollection": {
            "sessionDetails": {
                "season": "2"
            },
            "playhead": 0
        }
    }
})
Media Edge API

Call the sessionStart endpoint with season inside xdm.mediaCollection.sessionDetails:

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

Legacy implementation types (Analytics-only)

Media SDK JS 3.x

Pass the season in the contextData object using ADB.Media.VideoMetadataKeys.Season:

code language-javascript 
var contextData = {};
contextData[ADB.Media.VideoMetadataKeys.Season] = "2";

tracker.trackSessionStart(mediaInfo, contextData);
Chromecast

Use ADBMobile.media.VideoMetadataKeys.SEASON to set the season number in the StandardMediaMetadata property of the media object before calling trackSessionStart:

code language-javascript 
var mediaInfo = ADBMobile.media.createMediaObject("My Video", "video-123", 128,
  ADBMobile.media.StreamType.VOD, ADBMobile.media.MediaType.Video);
var standardMetadata = {};
standardMetadata[ADBMobile.media.VideoMetadataKeys.SEASON] = "2";
mediaInfo[ADBMobile.media.MediaObjectKey.StandardMediaMetadata] = standardMetadata;
ADBMobile.media.trackSessionStart(mediaInfo, null);
Media Collection API

Include media.season in the params object:

code language-json 
{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "sessionStart",
  "params": {
    "media.season": "2"
  }
}

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

recommendation-more-help
media-analytics-help