Skip to main content
POST
/
v1
/
insights
/
queries
/
{queryId}
/
run
Run a saved query
curl --request POST \
  --url https://public-api.sessionboard.com/v1/insights/queries/{queryId}/run \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "eventId": 123,
  "eventIds": [
    123
  ],
  "obfuscatePii": true,
  "format": "<string>",
  "page": 123,
  "limit": 123
}
'
{
  "data": [
    {}
  ],
  "pagination": {
    "currentPage": 123,
    "pageSize": 123,
    "totalPages": 123,
    "totalResults": 123
  }
}

Authorizations

x-access-token
string
header
required

API key for authentication. Obtain from the Sessionboard admin dashboard.

Path Parameters

queryId
string
required

The saved query ID.

Body

application/json
eventId
integer

Override the event scope for this run.

eventIds
integer[]

Override with multiple event scopes.

obfuscatePii
boolean
default:true
format
string
page
integer
limit
integer

Response

OK

data
object[]
pagination
object

Pagination metadata returned with list responses.