Execute a SbQL query

POST/v1/insights/execute

US Region: https://public-api.sessionboard.com · EU Region: https://public-api-eu.sessionboard.com

Execute a SbQL query against event data and return results. Requires the read:insights scope.

Request example

curl --request POST \
  --url 'https://public-api.sessionboard.com/v1/insights/execute' \
  --header 'x-access-token: <api-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "SELECT sessions.title, sessions.status FROM sessions",
  "eventId": 123,
  "eventIds": [
    123
  ],
  "obfuscatePii": false,
  "format": "<string>",
  "page": 123,
  "limit": 123,
  "search": "<string>",
  "sortBy": "<string>",
  "sortDirection": "asc",
  "groupBy": "<string>",
  "pivot": "<string>"
}'

const response = await fetch('https://public-api.sessionboard.com/v1/insights/execute', {
  method: 'POST',
  headers: {
    "x-access-token": "<api-token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "query": "SELECT sessions.title, sessions.status FROM sessions",
    "eventId": 123,
    "eventIds": [
      123
    ],
    "obfuscatePii": false,
    "format": "<string>",
    "page": 123,
    "limit": 123,
    "search": "<string>",
    "sortBy": "<string>",
    "sortDirection": "asc",
    "groupBy": "<string>",
    "pivot": "<string>"
  }),
});

const data = await response.json();
console.log(data);

import requests

response = requests.request(
    "POST",
    "https://public-api.sessionboard.com/v1/insights/execute",
    headers={
        "x-access-token": "<api-token>",
        "Content-Type": "application/json"
    },
    json={
        "query": "SELECT sessions.title, sessions.status FROM sessions",
        "eventId": 123,
        "eventIds": [
            123
        ],
        "obfuscatePii": False,
        "format": "<string>",
        "page": 123,
        "limit": 123,
        "search": "<string>",
        "sortBy": "<string>",
        "sortDirection": "asc",
        "groupBy": "<string>",
        "pivot": "<string>"
    },
)

print(response.json())

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://public-api.sessionboard.com/v1/insights/execute",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_POSTFIELDS => '{
  "query": "SELECT sessions.title, sessions.status FROM sessions",
  "eventId": 123,
  "eventIds": [
    123
  ],
  "obfuscatePii": false,
  "format": "<string>",
  "page": 123,
  "limit": 123,
  "search": "<string>",
  "sortBy": "<string>",
  "sortDirection": "asc",
  "groupBy": "<string>",
  "pivot": "<string>"
}',
    CURLOPT_HTTPHEADER => [
        "x-access-token: <api-token>",
        "Content-Type: application/json",
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
  "fmt"
  "io"
  "net/http"
  "strings"
)

func main() {
  req, _ := http.NewRequest("POST", "https://public-api.sessionboard.com/v1/insights/execute", strings.NewReader(`{
  "query": "SELECT sessions.title, sessions.status FROM sessions",
  "eventId": 123,
  "eventIds": [
    123
  ],
  "obfuscatePii": false,
  "format": "<string>",
  "page": 123,
  "limit": 123,
  "search": "<string>",
  "sortBy": "<string>",
  "sortDirection": "asc",
  "groupBy": "<string>",
  "pivot": "<string>"
}`))
  req.Header.Add("x-access-token", "<api-token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/insights/execute"))
    .header("x-access-token", "<api-token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"query\": \"SELECT sessions.title, sessions.status FROM sessions\",\n  \"eventId\": 123,\n  \"eventIds\": [\n    123\n  ],\n  \"obfuscatePii\": false,\n  \"format\": \"<string>\",\n  \"page\": 123,\n  \"limit\": 123,\n  \"search\": \"<string>\",\n  \"sortBy\": \"<string>\",\n  \"sortDirection\": \"asc\",\n  \"groupBy\": \"<string>\",\n  \"pivot\": \"<string>\"\n}"))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Try it

Response headers

Authorizations

x-access-tokenstringheaderrequired
Organization API token. Generate from Organization Settings → API Tokens.

Request body

application/jsonrequired

querystringrequired
The SbQL query string to execute.
eventIdinteger
Scope query to a single event.
eventIdsinteger[]
Scope query to multiple events.
obfuscatePiiboolean
Set to true to mask personal-data fields (such as emails and phone numbers) in the results. Results are not masked unless you send true.
Default
false
formatstring
Output format for results.
pageinteger
Page number for paginated results.
limitinteger
Maximum number of rows to return.
searchstring
Full-text search within results.
sortBystring
Column name to sort results by.
sortDirectionstring
Sort direction.
Allowed values
"asc", "desc"
groupBystring
Column name to group results by.
pivotstring
Column name to pivot results on.

Example

{
  "query": "SELECT sessions.title, sessions.status FROM sessions",
  "eventId": 123,
  "eventIds": [
    123
  ],
  "obfuscatePii": false,
  "format": "<string>",
  "page": 123,
  "limit": 123,
  "search": "<string>",
  "sortBy": "<string>",
  "sortDirection": "asc",
  "groupBy": "<string>",
  "pivot": "<string>"
}

Responses

200`application/json`

resultsobject[]
paginationPagination
Pagination metadata returned with POST search responses. The event-settings GET lists return the same numbers under snake_case keys — see ListPagination.
Show child attributes
- currentPageinteger
- pageSizeinteger
- totalPagesinteger
- totalResultsinteger

400

Invalid query

401

Unauthorized

403

Insufficient scope

Response examples

{
  "results": [
    {}
  ],
  "pagination": {
    "currentPage": 1,
    "pageSize": 25,
    "totalPages": 4,
    "totalResults": 97
  }
}