Sessions

Start a media session

Starts a new media tracking session with a sessionStart event. On success the response returns 201 Created with the session path in the Location header. Parse the trailing session ID from that header and use it in all subsequent events calls. Your app calls this once at the start of a tracking session.

post/sessions

Request

  • Base URL: https://example.hb-api.omtrdc.net/api/v1
  • URL: https://example.hb-api.omtrdc.net/api/v1/sessions
  • Auth: none declared. Required headers: Content-Type

Headers

Content-Typestring required

Must be application/json.

Request body

eventType'sessionStart' | 'sessionComplete' | 'sessionEnd' | 'adBreakStart' | 'adBreakComplete' | 'adStart' | 'adComplete' | 'adSkip' | 'chapterStart' | 'chapterComplete' | 'chapterSkip' | 'play' | 'ping' | 'bufferStart' | 'pauseStart' | 'bitrateChange' | 'error' | 'stateStart' | 'stateEnd' required

The media tracking event type sent on the wire.

customMetadataCustomMetadata

Free-form string key-value pairs. Sent only with the sessionStart, adStart, and chapterStart event types. All values must be strings.

Example request

{
  "playerTime": {
    "playhead": 0,
    "ts": 1731672000000
  },
  "eventType": "sessionStart",
  "params": {
    "analytics.trackingServer": "example.data.adobedc.net",
    "analytics.reportSuite": "example-rsid",
    "analytics.enableSSL": true,
    "visitor.marketingCloudOrgId": "0123456789ABCDEF0123456789@AdobeOrg",
    "media.id": "sample-video-id",
    "media.name": "Sample video",
    "media.length": 3600,
    "media.contentType": "vod",
    "media.playerName": "sample-html5-player",
    "media.channel": "sample-channel"
  }
}

Response

Session created. The session ID is returned in the Location response header.

Changes

No recorded changes to this operation across all 4 revisions of this API.