POST https://{uri}/api/v1/sessions/{sid}/events
sid
: The session ID returned from a Sessions request.
The request body must be JSON, and must have the same structure as this sample request body:
{
"playerTime": {
"playhead": 0,
"ts": 1509045324153
},
"eventType": "{event-type}",
"params": {},
"qoeData": {},
"customMetadata": {}
}
playerTime
(Mandatory)
playhead
- Must be in seconds, but it can be a float.ts
- Timestamp; must be in milliseconds.eventType
(Mandatory)params
(Optional)customMetadata
(Optional; send only with adStart
and chapterStart
event types)qoeData
(Optional)For a list of valid event types for this release, see Event types and descriptions.
Ad Tracking - You can only track ads inside an adBreak
.
In the absence of the adBreakStart
and adBreakComplete
“bookends” around ads, adStart
and adComplete
events will simply be ignored, and the corresponding ad duration will be tracked as main content duration. This could have a significant impact on the aggregated data which will be available in Adobe Analytics.
HTTP/1.1 204 No Content
Server nginx/1.13.5
Date Thu, 26 Oct 2017 19:15:24 GMT
Connection keep-alive
Access-Control-Allow-Origin *
Access-Control-Allow-Methods OPTIONS,POST,PUT
Access-Control-Allow-Headers Content-Type
Access-Control-Expose-Headers Location
HTTP Response Code | Description | Client Action Items |
---|---|---|
204 | No Content. Heartbeat call was successful. |
N/A |
400 | Bad Request. Request had improper format. |
Check the JSON validation schemas for the request type. |
404 | Not Found. The session ID for the media session was not found in the back-end service. |
The client application should use the Sessions request API to create another media session and report tracking on it. |
410 | Gone. The media session was found in the back-end service but the client can no longer report activity on it. |
The client application should use the Sessions request API to create another media session and report tracking on it. |
500 | Server error | N/A |