Skip to main content
GET
/
v1
/
query
Query metrics
curl --request GET \
  --url https://api.usethunder.com/v1/query/ \
  --header 'x-api-key: <api-key>'
{
  "elements": [
    {
      "dimensions": {
        "topic": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "clusterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "cluster": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>"
        },
        "session": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "<string>",
          "summary": "<string>",
          "topics": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>"
            }
          ],
          "language": "<string>"
        },
        "csatDsatSignal": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "signalType": "SAT",
          "description": "<string>"
        },
        "repeatedRequest": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "description": "<string>"
        },
        "gap": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "description": "<string>",
          "gapType": "TOOL",
          "topics": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>"
            }
          ]
        },
        "endUser": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "externalId": "<string>",
          "topTopics": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>"
            }
          ],
          "createdAt": "2023-11-07T05:31:56Z",
          "lastActiveAt": "2023-11-07T05:31:56Z"
        },
        "date": "<string>"
      },
      "fields": {
        "sessions": 123,
        "users": 123,
        "messages": 123,
        "avgMessagesPerSession": 123,
        "sat": 123,
        "dsat": 123,
        "netSat": 123,
        "duration": 123,
        "lastActiveAt": "2023-11-07T05:31:56Z",
        "repeatedRequests": 123
      }
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Authorizations

x-api-key
string
header
required

Your Thunder API key

Query Parameters

groupBy
enum<string>
required
Available options:
TOPIC,
TOPIC_CLUSTER,
REPEATED_REQUEST,
CSAT_DSAT,
GAP,
SESSION,
END_USER
instanceId
string<uuid>
required
dateRange.start
string<date-time>
dateRange.end
string<date-time>
timeGranularity
enum<string>
Available options:
ALL,
HOUR,
DAY,
WEEK,
MONTH
fields
string
required
ids
string
topicIds
string
signalIds
string
repeatedRequestIds
string
gapIds
string
gapType
enum<string>
Available options:
TOOL,
KNOWLEDGE
language
string
Maximum string length: 10
dimensionFields
string
limit
integer
default:50
Required range: 1 <= x <= 10000
offset
integer
default:0
Required range: 0 <= x <= 9007199254740991
sort.field
enum<string>
Available options:
sessions,
users,
messages,
avgMessagesPerSession,
sat,
dsat,
netSat,
duration,
lastActiveAt,
repeatedRequests,
createdAt
sort.order
enum<string>
Available options:
ASC,
DESC
minSessions
integer
Required range: 0 <= x <= 9007199254740991
maxSessions
integer
Required range: 0 <= x <= 9007199254740991
minMessages
integer
Required range: 0 <= x <= 9007199254740991
maxMessages
integer
Required range: 0 <= x <= 9007199254740991
minSat
integer
Required range: 0 <= x <= 9007199254740991
maxSat
integer
Required range: 0 <= x <= 9007199254740991
minDsat
integer
Required range: 0 <= x <= 9007199254740991
maxDsat
integer
Required range: 0 <= x <= 9007199254740991
minRepeatedRequests
integer
Required range: 0 <= x <= 9007199254740991
maxRepeatedRequests
integer
Required range: 0 <= x <= 9007199254740991

Response

Default Response

elements
object[]
required
pagination
object
required