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>",
          "description": "<string>"
        },
        "repeatedRequest": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "description": "<string>"
        },
        "gap": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "description": "<string>",
          "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
  },
  "lastProcessedAt": "2023-11-07T05:31:56Z"
}

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
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
dateRange.start
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
dateRange.end
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
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
​
lastProcessedAt
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$