api_operation - XBOX Game Development Documentation

This event is triggered to summarize the actions taken during an invocation of the segmentation CRUD API.

Properties

Name	Type	Description
Created	DateTime	The date and time when the operation was submitted.
Completed	DateTime	The date and time when the operation was completed.
Operation	SegmentOperation	The segment operation that was performed.
OperationStatus	SegmentOperationStatus	The status of the operation.
SegmentId	String	The ID of the segment.
SegmentName	String	The name of the segment.
SegmentDefinition	String	The segment definition.
EnteredSegmentActions	String	The actions triggered when a profile enters the segment.
LeftSegmentActions	String	The actions triggered when a profile exits the segment.

Common Properties

All V2 PlayStream events are formatted as JSON objects and most share the following common properties:

Name	Type	Description
SchemaVersion	String	PlayStream event format version, following a semantic versioning scheme.
FullName	Object	Combination of the event name and event namespace to fully specify the event type.
Id	String	PlayFab-assigned unique identifier for this event.
Timestamp	DateTime	The time (in UTC) associated with this event.
Entity	Object	Details about the entity to which this event applies including Entity Id and Entity type.
Originator	Object	Object describing the source and source type that initiated this event.
PayloadContentType	String	Specifies the content of the event payload. Default is “JSON”.
Origin Info	Object	Optional field containing info about events originating outside of PlayFab.

Last modified on August 3, 2026

Related topics

PlayStream event model reference for PlayFab PFInventoryExecuteInventoryOperationsAsync PFInventoryExecuteInventoryOperationsGetResult Switching sandboxes properly for store operations OperationTypes

⌘I