DocumentationExperience PlatformExperience Data Model (XDM) Guide

Chapter Details Reporting data type

Last update: Wed Apr 03 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer

Chapter Details Reporting is a standard Experience Data Model (XDM) data type that describes various attributes related to chapters or segments within media content. Use the Chapter Details Reporting data type to capture details such as chapter name, duration, position, ID, playback status (started/completed), and the time spent on each chapter. Media reporting fields are used by Adobe services to analyze the Media Collection fields sent by users. This data, alongside other specific user metrics, are computed and reported upon.

A diagram of the Chapter Details Reporting data type.

NOTE
Each display name contains a link to further information on its audio and video parameters. The linked pages contain details on the video ad data collected by Adobe, implementation values, network parameters, reporting, and important considerations.
Display name
Property
Data type
Description
Chapter Completed
isCompleted
boolean
Whether the chapter has completed or not.
Chapter ID
ID
string
The auto-generated ID of the chapter.
Chapter Length Or Duration
length
integer
The length of the chapter, in seconds.
Chapter Name
friendlyName
string
The name of the chapter and/or segment.
Chapter Offset
offset
integer
The offset of the chapter inside the content (in seconds) from the start.
Chapter Position
index
integer
The position (index, integer) of the chapter inside the content.
Chapter Started
isStarted
boolean
Whether the chapter has started or not.
Chapter Time Played
timePlayed
integer
The time spent on the chapter, in seconds.
recommendation-more-help
62e9ffd9-1c74-4cef-8f47-0d00af32fc07