Sign in
Event sets

Create event set

This endpoint can be used to create an event set that can later be paginated through with a cursor. The set will be persisted and available for pagination for approximately 24 hours.

When creating the event set the events may not be immediately available. Check the status property to determine if the events are available.

  • If in_progress, periodically check GET /event_sets/{id} until status is finished.
  • If finished, events will contain the events, and cursor will contain the cursor used to paginate the set.
post/event_sets

Request body

Response

OK

idinteger required

The ID of the event set

created_atstring date-time required

When the event set was created

status'in_progress' | 'finished' | 'failed' required

The status of the event set

intervalstring required

Filter by the creation date of the event. The timestamp is expected to be in ISO8601 format.

The interval defaults to the past 90 days. The interval cannot be wider than 90 days.

Supported patterns:

  • Start/End, eg. 2019-03-09T13:00:00Z/2019-03-10T15:30:00Z
  • Start/Duration, eg. 2019-03-09T13:00:00Z/P1Y2M10D
  • Duration/End, eg. PT2H30M/2019-03-09T15:30:00Z

Duration on its own (eg. P1Y2MT1H) is not supported.

event_actor_idinteger nullable required
event_actor_typestring nullable required
event_authenticated_by_idinteger nullable required
event_authenticated_by_typestring nullable required
event_object_idinteger nullable required
event_object_typestring nullable required
event_place_idinteger nullable required

The place ID to filter events by. Only one of event_place_id and place_id can be set.

event_successboolean nullable required
event_sequencestring nullable required

Multiple sequences are separated with ,

event_typestring nullable required

Multiple types are separated with ,

event_uuidstring nullable required

Multiple UUIDs are separated with ,

cursorstring nullable required

The cursor of the event set. Will be null if status is in_progress or if there are no more events.

place_idinteger nullable required

The place ID of a place-scoped event set. Only one of place_id and event_place_id can be set.

Changes

No recorded changes to this endpoint across all 1 revision of this API.