Skip to content
Bottle

The activity log as CSV

GET
/console/actions/export
curl --request GET \
  --url 'https://example.com/console/actions/export?area=businesses&tenantId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f&kind=breakGlass&order=asc' \
  --cookie bottle.session_token=<bottle.session_token>

The same filters as GET /console/actions, every page of them up to 10,000 rows, as a CSV file: when (UTC), who, what in words, the action, the business, the person and the details. Recorded as actions.exported.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
string
<= 120 characters
area
string
Allowed values: businesses people support trust pricing codes policies analytics exports
action
string
<= 80 characters
tenantId

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

staffUserId
string
personId
string
kind
string
Allowed values: breakGlass supportSessions system
from
string format: date
to
string format: date
order
string
default: desc
Allowed values: asc desc

Responses

Section titled “Responses”

200

Section titled “200”

The CSV

Media typetext/csv
string

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not Bottle staff, or no two-step sign-in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}