Sign in

v5

OpenAPI 3.1.02026-08-043621,4011.8 MB
access:all

List Api Requests

Returns a list of API requests. Supports filtering by time range, column filters, and search terms. At least one of start_time or end_time must be provided. An optional sort parameter controls timestamp ordering. Results are ordered by timestamp. Descending if end_time is used, ascending if start_time is used. The response is a tabular structure with columns, column_types, column_units, and rows.

post/v1/workspace/analytics/requests

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

start_timeinteger nullable

Start of the time range as a Unix timestamp in milliseconds.

end_timeinteger nullable

End of the time range as a Unix timestamp in milliseconds.

limitinteger
sort'asc' | 'desc' nullable

Optional timestamp sort direction. If omitted, defaults to desc when end_time is provided, otherwise asc.

searchstring nullable

Response

Successful Response

columnsstring[] required
column_typesstring[] required
column_unitsColumnUnit[] required