The content session object
A content session represents a user’s interaction with a specific content object (flow, checklist, or launcher). It tracks the user’s progress, records their survey responses, and maintains the state of their journey through the content.
A unique identifier for the content session.
The object type identifier. Always set to “contentSession” to distinguish it from other API objects.
A collection of content session answer objects containing the user’s responses to survey questions. This field is only populated for flow sessions and can be expanded using the ?expand=answers
query parameter.
The timestamp when the content was completed, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ). Returns null if the content is not yet completed.
Indicates whether the content has been completed. For flows, completion occurs when the user reaches a goal step. For checklists, completion means all tasks have been finished.
The identifier of the content object (flow, checklist, or launcher) associated with this session.
The associated content object. Can be expanded using the ?expand=content
query parameter.
The timestamp when the session was first created, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ).
The identifier of the company associated with this session, if applicable.
The associated company object. Can be expanded using the ?expand=company
query parameter.
Indicates whether this session was initiated by a team member previewing a draft version of the content.
The timestamp of the user’s last interaction with the content (e.g., advancing to the next step, expanding a checklist), in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ).
A decimal value representing the user’s progress through the content, where 1.0 indicates 100% completion. For example, 0.4 represents 40% progress.
The identifier of the user who is viewing the content.
The associated user object. Can be expanded using the ?expand=user
query parameter.
The identifier of the content version being used in this session.
The associated content version object. Can be expanded using the ?expand=version
query parameter.