Retrieve organization events

Retrieve the complete list of events for an organization; the retention period for events is thirty days.
If multiple events are generated with the same timestamp, to the second, and the same media type, the media file from the last request is used for all of them. To have different media files for each virtual event, use timestamps that differ by at least a second.

Request
Security:
path Parameters
orgId
required
string

The ID of the organization. Obtain this from GET /organizations.

Example: 62
query Parameters
start
string <date-time> (Start date and time)

Filter by a start date and time, in ISO 8601 format.

Example: start=2020-01-01T14:48:00.000Z
end
string <date-time> (End date and time)

Filter by an end date and time, in ISO 8601 format.

Example: end=2020-01-01T14:48:00.000Z
limit
string^([1-9]|[0-9][0-9]|1[0-9][0-9]|200)$
Default: "200"

Set the maximum number of pagination results to receive, between 1 and 200.

Example: limit=20
offset
string^[0-9]\d*$
Default: "0"

Set the number of results to skip over before receiving pagination results.

Example: offset=1
Request Body schema: application/json
Array of Configurable Events (string) or Unconfigurable Events (string) (All Events)
Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

post/organizations/{orgId}/events
Request samples
application/json
{
  • "eventTypes": [
    ]
}
Response samples
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}