GET
/
events
curl --request GET \
  --url https://auditr.io/api/events \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "sha256": "<string>",
      "parent_org_id": "<string>",
      "client_geo_lat": 123,
      "client_geo_lon": 123,
      "client_city": "<string>",
      "client_region_code": "<string>",
      "client_subdivision_1_code": "<string>",
      "user_agent_name": "<string>",
      "user_agent_version": "<string>",
      "org_id": "<string>",
      "action": "<string>",
      "action_result": "success",
      "actor_id": "<string>",
      "actor_type": "user",
      "actor_email": "jsmith@example.com",
      "actor_name": "<string>",
      "client_ip": "<string>",
      "request_method": "<string>",
      "request_path": "<string>",
      "response_status": 123,
      "occurred_at": "2023-11-07T05:31:56Z"
    }
  ],
  "rows": 123,
  "rows_before_limit_at_least": 123,
  "statistics": {
    "elapsed": 123,
    "rows_read": 123,
    "bytes_read": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
start_date
string
required

Starting date range of events to retrieve in ISO format

Example:

"2024-05-12T22:00:47.941Z"

​
end_date
string
required

Ending date range of events to retrieve in ISO format

Example:

"2024-05-20T22:00:47.941Z"

​
filter
string

Values to filter by.

​
page
integer

Page number. Default: 0.

Required range: x >= 0
​
page_size
integer

The number of events per page. Default: 10. Max: 100.

Required range: 1 <= x <= 100

Response

200
application/json
A list of events
​
data
object[]

Tag to specify the type

​
rows
integer

Number of rows returned

​
rows_before_limit_at_least
integer

Number of rows before limit

​
statistics
object

Statistics related to the event query