Media Edge API overview

The Adobe Experience Platform Media Edge APIs allow you to send media data within the framework of XDM schemas. Use of these APIs require the Streaming Media Collection Add-on.

• With Adobe Customer Journey Analytics, you can get near real-time, granular details of duration, starts, and stops to evaluate and combine for media metrics. If migrating from Adobe Analytics, all reporting metrics are available in Customer Journey Analytics.
• With Adobe Real-Time Customer Data Platform, you can enrich real-time profiles with media consumption data.
• With Adobe Journey Optimizer, you can optimize omnichannel campaigns and automate journeys with media consumption signals.

See Media Edge API examples to learn more about how to structure multiple API calls together to build a media tracking session.

Optimizing media tracking data flows

Both Media Collection APIs and Media Edge APIs provide media tracking data as RESTful services. The Media Edge service offers the following advantages:

• It is the easiest way to incorporate XDM schemas into your data flow.
• Calls are directed from a media player directly to the Experience Platform Edge Network.
• It tracks media events efficiently with a minimum of cross-server calls.

The following table shows a possible Adobe API service for various media analytics cases:

The Media Collection API service for Analytics still receives XDM data, but is not optimized for it to the extent that Media Edge service is. Depending on the data sent from the Media Player, some Analytics-only data can also be routed through the Media Edge API service.

Including custom meta data

Custom meta data allows the inclusion of additional user-defined data that can be customized for specific needs. It is useful when default media schemas do not cover desired data points. Since media calls go through a different processing pipeline, you must use the xdm.customMetadata object array to include non-media schema fields in your tracking.

Include the xdm.customMetadata object array in your payload when you call the sessionStart, chapterStart, or adStart endpoints.

The following example sessionStart request includes a single key-value pair; a custom user ID that is ultimately mapped to xdm._expath.customUserID. You can include as many custom key-value pairs in the xdm.customMetadata object as you'd like.

Copy
curl -X POST "https://edge.adobedc.net/ee/va/v1/sessionStart?configId={datastreamId}" \
--header 'Content-Type: application/json' \
--data '{
  "events": [
    {
      "xdm": {
        "eventType": "media.sessionStart",
        "mediaCollection": {
          "sessionDetails": {
            "name": "Media Analytics API Sample",
            "playerName": "sample-html5-api-player",
            "contentType": "VOD",
            "length": 60,
            "channel": "sample-channel"
          },
          "playhead": 0,
          "customMetadata": [
            {
              "name": "_expath.customUserID",
              "value": "5791626"
            }
          ]
        }
      }
    }
  ]
}'
Copied to your clipboard
curl -X POST "https://edge.adobedc.net/ee/va/v1/sessionStart?configId={datastreamId}" \
--header 'Content-Type: application/json' \
--data '{
  "events": [
    {
      "xdm": {
        "eventType": "media.sessionStart",
        "mediaCollection": {
          "sessionDetails": {
            "name": "Media Analytics API Sample",
            "playerName": "sample-html5-api-player",
            "contentType": "VOD",
            "length": 60,
            "channel": "sample-channel"
          },
          "playhead": 0,
          "customMetadata": [
            {
              "name": "_expath.customUserID",
              "value": "5791626"
            }
          ]
        }
      }
    }
  ]
}'

If successfully processed, the API returns 200 OK for the sessionStart endpoint or 204 No Content for all other endpoints.

Last updated 11/12/2024

Was this helpful?

Yes

No