v1

latestOpenAPI 3.1.02026-08-04197263.3 KB

Export Activity Data

Export Cygnal activity data for the authenticated organization.

Requires admin role.

get/activity/export

Query parameters

cursorstring nullable

Cursor for pagination (ObjectId from previous response)

Cursor for pagination (ObjectId from previous response)

sincestring nullable

ISO 8601 timestamp to filter events after this time

ISO 8601 timestamp to filter events after this time

untilstring nullable

ISO 8601 timestamp to filter events before this time

ISO 8601 timestamp to filter events before this time

limitinteger

Maximum number of activity records to return

Maximum number of activity records to return

searchstring nullable

Free-text search is temporarily unavailable and ignored; use cursor, time range, or alarm filters instead.

Free-text search is temporarily unavailable and ignored; use cursor, time range, or alarm filters instead.

alarm_onlyboolean

Only return events where alarm=True

Only return events where alarm=True

Response

Successful Response

activitiesobject[] required
next_cursorstring nullable required
has_moreboolean required