Retrieve Marker Events

This operation returns marker events according to the specified criteria.

Marker events can be returned according to the following criteria:

• Marker type IDs or names -- Marker types must be of the same cadence. Marker types with different cadences cannot be returned in a single call.
• Time frame -- The start and end date and time of the marker events. The specified date range must be equivalent to or a multiple of a change marker's cadence.
• Page index -- The page index applies to paginated response bodies. Note that if you specify a page index along with any other query parameters, all other parameters except page index are ignored.
• Additional options -- You can also specify a page size or cadence. The subscription's existing cadence is used if no cadence is specified.

Note: To call the next page of results, use the pageIndex property.

Request example

The following request payload demonstrates a valid call when using the pageIndex property:

{
  "options": {
    "pageIndex": "eyJtYXJrZXJzIjpbInRpbWVrZWVwaW5n"
  }
}