Pause start endpoint
The pauseStart endpoint lets you track when the media player is paused.
A "Resume" endpoint does not exist using this API; instead, it is inferred when you call the play endpoint following pauseStart. Call the play endpoint when the media player resumes playing content.
Usage of this endpoint requires an active session. Make sure that you call the sessionStart endpoint first to obtain a valid session ID.
pauseStart
POST https://edge.adobedc.net/ee/va/v1/pauseStart?configId={datastreamID}
Request
Copied to your clipboardcurl -X POST "https://edge.adobedc.net/ee/va/v1/pauseStart?configId={datastreamID}" \--header 'Content-Type: application/json' \--data '{"events": [{"xdm": {"eventType": "media.pauseStart","mediaCollection": {"sessionID": "ffab5[...]45ec3","playhead": 0},"timestamp": "YYYY-08-20T22:41:40+00:00"}}]}'
If successfully processed, the API returns 204 No Content.
This endpoint requires the following payload properties within the xdm object:
| XDM property | Description |
|---|---|
eventType | The category of the event. Always set this property to media.pauseStart for this endpoint. |
mediaCollection | An object containing media collection details. See Media Collection Details data type in the Experience Data Model guide for more information. The sessionID and playhead properties are required. |
timestamp | The timestamp of the event. |
