API referenceActivity

Who did what, and when

The audit trail for this business, newest first. Ordered by `occurred_at` and then by id. Entries written in one transaction share a timestamp — it is the transaction's — so ordering by time alone would page inconsistently and could show or skip a row. Refused actions appear alongside successful ones. Filtering them out would remove the entries an investigation is usually looking for.

GET
/api/b/v1/activity

The audit trail for this business, newest first.

Ordered by occurred_at and then by id. Entries written in one transaction share a timestamp — it is the transaction's — so ordering by time alone would page inconsistently and could show or skip a row.

Refused actions appear alongside successful ones. Filtering them out would remove the entries an investigation is usually looking for.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Query Parameters

action?|

Narrow to one kind of event.

actor_user_id?|

Narrow to one person's actions.

since?|null
until?|null
limit?Limit
Range1 <= value <= 200
Default50
offset?Offset
Range0 <= value
Default0
admin_access_token?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/activity"
{  "entries": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "occurred_at": "2019-08-24T14:15:22Z",      "action": "string",      "succeeded": true,      "actor_type": "user",      "actor_user_id": "d6ed4497-4325-4995-9f49-e288b7192e46",      "actor_name": "string",      "actor_api_key_id": "945eb2d0-7bc5-4328-8f71-de82883957d2",      "target_type": "string",      "target_id": "d3bcdc92-4191-401b-ad0c-42056c6efab9",      "target_label": "string",      "changes_before": {},      "changes_after": {},      "ip_address": "string",      "request_id": "string"    }  ],  "known_actions": [    "string"  ]}