Upload schedule data to track live content

Reads from the schedule program dataset for schedule program records, filtering by the date of the schedule.

Only works for programs that occurred 24 hours to 48 hours in the past.

Reads the media close events from the media dataset, filtering by date and by the XDM path in the schedule program records.

For each media close event, the same number of media schedule start events are generated as there were shows overlapping with the media session.

Each media schedule start event contains the name and the length of the schedule.

Also, a new time metric called scheduleTimePlayed contains the number of seconds that the media session overlapped with the scheduled program. The timestamp of the schedule start event is the timestamp of when the show started.

Writes the new schedule start events in the AEP media dataset.

Create a schema based on the Media Analytics Scheduled Program XDM class.

This is the XDM definition of the Media Analytics Scheduled program class.

https://github.com/adobe/xdm/blob/master/components/fieldgroups/tv-schedule/media-analytics-scheduled-program.schema.json

Create a dataset based on the schema that you created.

Continue with the following section, Push schedule information.

Create a .json file with the schedule information.

The .json file must contain an array of Schedule Program objects, in accordance with the XDM schema.

Upload the .json file:

1. Create a new batch, then get the batch id from the response.

   Consider the following example of using cURL to create a new AEP Batch:

   code language-none

   curl -i 'https://platform.adobe.io/data/foundation/import/batches' \ -X POST \ -H 'Accept: application/json' \ -H 'x-api-key: <CUSTOMER_API_KEY>' \ -H 'x-gw-ims-org-id: <CUSTOMER_ORG_ID>' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer <OAUTH_TOKEN>' \ --data-raw '{"datasetId":"<DATASET_ID>","inputFormat":{"format":"json","isMultiLineJson":true},"tags":{"test":["2"]}}' HTTP/1.1 201 Created { "id": "BATCH_ID", "imsOrg": "CUSTOMER_ORG_ID", "updated": 1749838941763, "status": "loading", "created": 1749838941763, "relatedObjects": [ { "type": "dataSet", "id": "DATASET_ID" } ], "version": "1.0.0", ............ }

2. Push the .json file that contains the program schedule data records using the batch id.

   To push schedule information you should use AEP batch APIs, as described in Batch ingestion API overview.

   Consider the following example of using cURL to push a file with the schedule records:

   code language-none
   curl -i 'https://platform.adobe.io/data/foundation/import/batches/<BATCH_ID>/datasets/<DATASET_ID>/files/<FILE_NAME>' \ -X PUT \ -H 'x-api-key: <CUSTOMER_API_KEY>' \ -H 'x-gw-ims-org-id: <CUSTOMER_ORG_ID>' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer <OAUTH_TOKEN>' \ --upload-file ./schedule_21_05_2025.json`

3. Complete the batch.

   Consider the following example of using cURL to complete the batch:

   code language-none
   curl -i 'https://platform.adobe.io/data/foundation/import/batches/<BATCH_ID>?action=COMPLETE' \ -X POST \ -H 'x-api-key: <CUSTOMER_API_KEY>' \ -H 'x-gw-ims-org-id: <CUSTOMER_ORG_ID>' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer <OAUTH_TOKEN>'

Continue with the following section, Log a support ticket with Adobe Customer Care.

mediaProgramDetails: Should contain the minimum information required to create the schedule start event:

• startTimestamp: The time when the show started.

• name: The friendly name of the show.

• length: The number of seconds the show lasted.

  note important
  IMPORTANT
  If you have multiple schedule data requests, they cannot have overlapping start and end times.

scheduleDate: The date on which the show was aired. The format should be YYYY-MM-DD. It is used to filter the schedule dataset and get all the schedules for which adobe creates schedule starts.

scheduleFilter: Used to filter all media session close events.

• filterPath: An XDM path to the field that is used for filtering.
• filterValue: The value used for filtering.

customMetadata: Custom metadata that you want to add to the schedule starts events. This metadata is used to overwrite the custom metadata present on the session close events.

defaultMetadata: A specific list of dimensions that can add or overwrite the default medatata present on the media close calls.

Consider the following examples of dimensions you could create and then report on in Customer Journey Analytics:

• “Episode name”: This dimension could help you learn which episodes in a particular series are performing best.

• Asset ID

Continue with Analyze data in Customer Journey Analytics.

Create a new project or open an existing project.

Build out the project by creating any tables or visualizations that you need for analyzing your past live Streaming Media data.

When building out the project, use the information that you included in the schedule data file and sent to Adobe Customer Care. This includes the matching key, dimensions, and any additional metadata. For more information, see Request and upload the schedule data file.