> ## Documentation Index > Fetch the complete documentation index at: https://docs.usethunder.com/llms.txt > Use this file to discover all available pages before exploring further. # Query Metrics > Query aggregated metrics for topics or topic clusters within a date range. ## OpenAPI ````yaml GET /v1/query/ openapi: 3.0.3 info: title: Thunder API description: API for ingesting conversation data and querying analytics version: 1.0.0 servers: - url: https://api.usethunder.com description: Production - url: http://localhost:3001 description: Local development security: - apiKey: [] tags: - name: Ingest description: Ingest conversation messages - name: Query description: Query topic and cluster metrics paths: /v1/query/: get: tags: - Query summary: Query metrics description: >- Query aggregated metrics for topics or topic clusters within a date range. operationId: queryMetrics parameters: - schema: type: string enum: - TOPIC - TOPIC_CLUSTER - REPEATED_REQUEST - CSAT_DSAT - GAP - SESSION - END_USER in: query name: groupBy required: true - schema: type: string format: uuid 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)$ in: query name: instanceId required: true - schema: type: string format: 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))$ in: query name: dateRange.start required: false - schema: type: string format: 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))$ in: query name: dateRange.end required: false - schema: type: string enum: - ALL - HOUR - DAY - WEEK - MONTH in: query name: timeGranularity required: false - schema: type: string in: query name: fields required: true - schema: type: string in: query name: ids required: false - schema: type: string in: query name: topicIds required: false - schema: type: string in: query name: signalIds required: false - schema: type: string in: query name: repeatedRequestIds required: false - schema: type: string in: query name: gapIds required: false - schema: type: string enum: - TOOL - KNOWLEDGE in: query name: gapType required: false - schema: type: string maxLength: 10 in: query name: language required: false - schema: type: string in: query name: dimensionFields required: false - schema: default: 50 type: integer minimum: 1 maximum: 10000 in: query name: limit required: false - schema: default: 0 type: integer minimum: 0 maximum: 9007199254740991 in: query name: offset required: false - schema: type: string enum: - sessions - users - messages - avgMessagesPerSession - sat - dsat - netSat - duration - lastActiveAt - repeatedRequests - createdAt in: query name: sort.field required: false - schema: type: string enum: - ASC - DESC in: query name: sort.order required: false - schema: type: integer minimum: 0 maximum: 9007199254740991 in: query name: minSessions required: false - schema: type: integer minimum: 0 maximum: 9007199254740991 in: query name: maxSessions required: false - schema: type: integer minimum: 0 maximum: 9007199254740991 in: query name: minMessages required: false - schema: type: integer minimum: 0 maximum: 9007199254740991 in: query name: maxMessages required: false - schema: type: integer minimum: 0 maximum: 9007199254740991 in: query name: minSat required: false - schema: type: integer minimum: 0 maximum: 9007199254740991 in: query name: maxSat required: false - schema: type: integer minimum: 0 maximum: 9007199254740991 in: query name: minDsat required: false - schema: type: integer minimum: 0 maximum: 9007199254740991 in: query name: maxDsat required: false - schema: type: integer minimum: 0 maximum: 9007199254740991 in: query name: minRepeatedRequests required: false - schema: type: integer minimum: 0 maximum: 9007199254740991 in: query name: maxRepeatedRequests required: false responses: '200': description: Default Response content: application/json: schema: type: object properties: elements: type: array items: type: object properties: dimensions: type: object properties: topic: type: object properties: id: type: string format: uuid 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)$ name: type: string clusterId: nullable: true type: string format: uuid 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)$ required: - id - name - clusterId additionalProperties: false cluster: type: object properties: id: type: string format: uuid 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)$ name: type: string required: - id - name additionalProperties: false session: type: object properties: id: type: string format: uuid 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)$ title: nullable: true type: string summary: nullable: true type: string topics: type: array items: type: object properties: id: type: string format: uuid 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)$ name: type: string required: - id - name additionalProperties: false language: nullable: true type: string required: - id additionalProperties: false csatDsatSignal: type: object properties: id: type: string format: uuid 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)$ name: type: string signalType: type: string enum: - SAT - DSAT description: type: string required: - id - name - signalType - description additionalProperties: false repeatedRequest: type: object properties: id: type: string format: uuid 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)$ name: type: string description: type: string required: - id - name - description additionalProperties: false gap: type: object properties: id: type: string format: uuid 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)$ name: type: string description: type: string gapType: type: string enum: - TOOL - KNOWLEDGE topics: type: array items: type: object properties: id: type: string format: uuid 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)$ name: type: string required: - id - name additionalProperties: false required: - id - name - description - gapType additionalProperties: false endUser: type: object properties: id: type: string format: uuid 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)$ externalId: type: string topTopics: type: array items: type: object properties: id: type: string format: uuid 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)$ name: type: string required: - id - name additionalProperties: false createdAt: type: string format: 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))$ lastActiveAt: nullable: true type: string format: 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))$ required: - id additionalProperties: false date: type: string additionalProperties: false fields: type: object properties: sessions: type: number users: type: number messages: type: number avgMessagesPerSession: type: number sat: type: number dsat: type: number netSat: nullable: true type: number duration: nullable: true type: number lastActiveAt: nullable: true type: string format: 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))$ repeatedRequests: type: number additionalProperties: false required: - dimensions - fields additionalProperties: false pagination: type: object properties: total: type: number limit: type: number offset: type: number required: - total - limit - offset additionalProperties: false lastProcessedAt: nullable: true type: string format: 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))$ required: - elements - pagination - lastProcessedAt additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: success: type: boolean enum: - false error: type: object properties: code: type: string message: type: string details: {} required: - code - message additionalProperties: false required: - success - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: success: type: boolean enum: - false error: type: object properties: code: type: string message: type: string details: {} required: - code - message additionalProperties: false required: - success - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: success: type: boolean enum: - false error: type: object properties: code: type: string message: type: string details: {} required: - code - message additionalProperties: false required: - success - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: success: type: boolean enum: - false error: type: object properties: code: type: string message: type: string details: {} required: - code - message additionalProperties: false required: - success - error additionalProperties: false components: securitySchemes: apiKey: type: apiKey name: x-api-key in: header description: Your Thunder API key ````