> ## Documentation Index > Fetch the complete documentation index at: https://docs.theymes.com/llms.txt > Use this file to discover all available pages before exploring further. # Query stats > **This endpoint does not create or change any data.** POST is used because the query is a nested JSON body. Query insights for the company associated with the API key. Send one or more metrics and one timeframe, and optionally shared filters, one breakdown, and one segment. See [Querying stats](/developers/insights/querying-stats) for how to use the endpoint with examples. The body data below lists supported metrics, breakdowns and filters. ## OpenAPI ````yaml https://api.theymes.com/v2/openapi.json post /insights/stats openapi: 3.1.0 info: title: Theymes API v2 version: 2.0.0 description: >- Theymes API allows you to interact with the Theymes platform. Most endpoints require an API key for authentication. You can generate an API key in the Theymes dashboard. The API key should be included in the Authorization header (```Authorization: Bearer ```). The public support link endpoints do not require authentication and are grouped separately below. servers: - url: https://api.theymes.com/v2 security: [] tags: - name: Authenticated endpoints (API key) description: Endpoints that require an API key in the Authorization header. - name: Public support links (no authentication) description: >- Endpoints for creating web support sessions and links. These require no authentication and are identified by an app environment token. paths: /insights/stats: post: tags: - Authenticated endpoints (API key) summary: Query stats description: >- **This endpoint does not create or change any data.** POST is used because the query is a nested JSON body. Query insights for the company associated with the API key. Send one or more metrics and one timeframe, and optionally shared filters, one breakdown, and one segment. See [Querying stats](/developers/insights/querying-stats) for how to use the endpoint with examples. The body data below lists supported metrics, breakdowns and filters. operationId: queryStats parameters: - schema: type: string description: Bearer token API key required: true description: Bearer token API key name: Authorization in: header requestBody: required: true content: application/json: schema: type: object properties: metrics: type: array items: $ref: '#/components/schemas/StatsMetric' minItems: 1 description: >- Metrics to calculate. Values in each stats row follow this order. filters: type: array items: $ref: '#/components/schemas/StatsFilter' title: StatsFilter description: >- Filters applied to every metric, in addition to each metric's own filters. timeframe: $ref: '#/components/schemas/StatsTimeframe' breakdown: allOf: - $ref: '#/components/schemas/StatsBreakdown' - description: >- Split each stats row by one dimension. The row `breakdown` is that dimension's display name. segment: allOf: - $ref: '#/components/schemas/StatsBreakdown' - description: Second dimension, returned on each row as `segment`. required: - metrics - timeframe additionalProperties: false description: Stats query. This request does not create or change data. responses: '200': description: Calculated stats. This response is a read of existing data. content: application/json: schema: type: object properties: metrics: type: array items: $ref: '#/components/schemas/StatsMetric' minItems: 1 timeframe: $ref: '#/components/schemas/StatsTimeframe' breakdown: $ref: '#/components/schemas/StatsBreakdown' segment: $ref: '#/components/schemas/StatsBreakdown' stats: type: array items: type: object properties: timeframe: type: object properties: type: type: string enum: - TODAY - PAST_7_DAYS - PAST_30_DAYS - PAST_90_DAYS - PAST_365_DAYS - CUSTOM from: anyOf: - type: string format: date - type: object properties: date: type: string format: date hours: type: integer minimum: 0 maximum: 23 description: Hour of the day, 0-23. required: - date - hours to: anyOf: - type: string format: date - type: object properties: date: type: string format: date hours: type: integer minimum: 0 maximum: 23 description: Hour of the day, 0-23. required: - date - hours required: - type - from - to description: Resolved range for this row. metrics: type: array items: type: - number - 'null' description: >- One value per requested metric, in request order. Null when the metric has no value for the row. breakdown: type: - string - 'null' description: >- Display name for the requested breakdown, or null when it is empty. segment: type: - string - 'null' description: >- Display name for the requested segment, or null when it is empty. required: - metrics required: - metrics - timeframe - stats '400': description: Invalid stats query '403': description: API key authentication required components: schemas: StatsMetric: type: object properties: type: type: string enum: - CSAT - CSAT_TOP_TWO_BOX_RATE - CSAT_RESPONSE_RATE - CREATED_TICKETS - CLOSED_TICKETS - RESOLVED_TICKETS - REJECTED_TICKETS - AUTO_CLOSED_TICKETS - MERGED_TICKETS - ASSIGNED_TICKETS - REPLIED_TICKETS - PUBLIC_ACTIVITY_TICKETS - ANY_ACTIVITY_TICKETS - OPEN_TICKETS - AGENT_MESSAGES - AUTOMATIC_MESSAGES_PER_TICKET - OUTGOING_MESSAGES_PER_TICKET - CUSTOMER_MESSAGES - TIME_TO_FIRST_RESPONSE - TIME_TO_CLOSE - TIME_TO_RESPONSE_FROM_EARLIEST_MSG - TIME_TO_RESPONSE_FROM_LATEST_MSG - BACKLOG_WAIT_TIME - ARTICLE_DEFLECTION_RATE - DEFLECTION_RATE - ARTICLE_VIEWS - ARTICLE_REFERENCED_IN_RAG - ARTICLE_HELPED_YES - ARTICLE_HELPED_NO - ROLLING_RETENTION_1_DAY - ROLLING_RETENTION_3_DAYS - ROLLING_RETENTION_7_DAYS - ROLLING_RETENTION_14_DAYS - ROLLING_RETENTION_30_DAYS - AVAILABLE_AGENTS - UNAVAILABLE_AGENTS - REOPENED_TICKETS - REOPEN_RATE - TIME_TO_RESPONSE_FROM_ASSIGN - PENDING_TIME_FROM_ASSIGN - FCR - FCR_RATE - RESOLUTION_ACCEPTANCE_RATIO - CPH - APH - AGENT_MESSAGES_PER_HOUR - AGENT_ONLINE_TIME description: Metric to calculate. filters: type: array items: $ref: '#/components/schemas/StatsFilter' title: StatsFilter description: >- Filters applied to this metric only, in addition to the shared filters. required: - type StatsFilter: anyOf: - type: object properties: type: type: string enum: - ticketId op: type: string enum: - include-all - include-any - exclude-all - exclude-any value: type: array items: type: string required: - type - op - value title: ticketId - type: object properties: type: type: string enum: - app op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string description: Ids to match. required: - type - op - value title: app - type: object properties: type: type: string enum: - team op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string description: Ids to match. required: - type - op - value title: team - type: object properties: type: type: string enum: - theymesCustomerId op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string description: Ids to match. required: - type - op - value title: theymesCustomerId - type: object properties: type: type: string enum: - status op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string enum: - new - assigned - unassigned - waiting - on_hold - closed required: - type - op - value title: status - type: object properties: type: type: string enum: - category op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string description: Ids to match. required: - type - op - value title: category - type: object properties: type: type: string enum: - subCategory op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string description: Ids to match. required: - type - op - value title: subCategory - type: object properties: type: type: string enum: - article op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string description: Ids to match. required: - type - op - value title: article - type: object properties: type: type: string enum: - assignee op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string format: uuid description: User ids. required: - type - op - value title: assignee - type: object properties: type: type: string enum: - latestAssignee op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string format: uuid description: User ids. required: - type - op - value title: latestAssignee - type: object properties: type: type: string enum: - language op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string enum: - en - de - es - es-AR - es-MX - fi - fil - fr - id - ja - ko - ms - pt - pt-BR - ru - tr - uk - vi - zh - zh-Hans - zh-Hant - ar - cs - da - nl - el - hu - it - 'no' - nb - pl - ro - sk - sv - th required: - type - op - value title: language - type: object properties: type: type: string enum: - platform op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string enum: - ios - android - win - macos - linux - web - widget - discord - email - messenger - api - started_by_agent - playstation_4 - playstation_5 - switch - switch_2 - xbox_series - xbox_one - not_specified required: - type - op - value title: platform - type: object properties: type: type: string enum: - supportSource op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string enum: - IN_APP - WIDGET - EMAIL - MESSENGER - WEB - API - STARTED_BY_AGENT - TEST_GENERATED - MIGRATED required: - type - op - value title: supportSource - type: object properties: type: type: string enum: - channel op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string enum: - chat - email - messenger required: - type - op - value title: channel - type: object properties: type: type: string enum: - csat op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: integer minimum: 1 maximum: 5 required: - type - op - value title: csat - type: object properties: type: type: string enum: - csat op: type: string enum: - is-set value: type: 'null' required: - type - op - value title: csatIsSet - type: object properties: type: type: string enum: - csat op: type: string enum: - is-not-set value: type: 'null' required: - type - op - value title: csatIsNotSet - type: object properties: type: type: string enum: - similarTicketIssue op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string description: Ids to match. required: - type - op - value title: similarTicketIssue - type: object properties: type: type: string enum: - similarTicketIssue op: type: string enum: - is-set value: type: 'null' required: - type - op - value title: similarTicketIssueIsSet - type: object properties: type: type: string enum: - similarTicketIssue op: type: string enum: - is-not-set value: type: 'null' required: - type - op - value title: similarTicketIssueIsNotSet - type: object properties: type: type: string enum: - tag op: type: string enum: - include-all - include-any - exclude-all - exclude-any value: type: array items: type: string required: - type - op - value title: tag - type: object properties: type: type: string enum: - tag op: type: string enum: - is-set value: type: 'null' required: - type - op - value title: tagIsSet - type: object properties: type: type: string enum: - tag op: type: string enum: - is-not-set value: type: 'null' required: - type - op - value title: tagIsNotSet - type: object properties: type: type: string enum: - field fieldType: type: string enum: - boolean - date - dropdown - number - text fieldKey: type: string op: type: string enum: - include-all - include-any - exclude-all - exclude-any - contains - not-contains - before - after - between - greater-than - less-than - is - is-not - is-set - is-not-set value: anyOf: - type: array items: type: string - type: string - type: object properties: type: type: string enum: - date date: oneOf: - type: object properties: type: type: string enum: - 1_HOUR_AGO - 3_HOUR_AGO - 6_HOUR_AGO - 12_HOUR_AGO - 1_DAY_AGO - 2_DAYS_AGO - 3_DAYS_AGO - 7_DAYS_AGO - 14_DAYS_AGO - 30_DAYS_AGO - 365_DAYS_AGO required: - type - type: object properties: type: type: string enum: - CUSTOM date: type: string format: date required: - type - date required: - type - date - type: object properties: type: type: string enum: - date-range from: type: object properties: type: type: string enum: - CUSTOM date: type: string format: date required: - type - date to: type: object properties: type: type: string enum: - CUSTOM date: type: string format: date required: - type - date required: - type - from - to - type: number - type: object properties: type: type: string enum: - number-range min: type: number max: type: number required: - type - min - max - type: boolean required: - type - fieldType - fieldKey - op - value title: field - type: object properties: type: type: string enum: - customerTier op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: integer minimum: 0 maximum: 3 required: - type - op - value title: customerTier - type: object properties: type: type: string enum: - reopenStatus op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string enum: - reopened - reopen_follow_up - not_reopened required: - type - op - value title: reopenStatus - type: object properties: type: type: string enum: - resolutionType op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string enum: - resolved - rejected - auto_closed - merged required: - type - op - value title: resolutionType - type: object properties: type: type: string enum: - messageSource op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string enum: - AGENT - AUTOMATIC - CUSTOMER required: - type - op - value title: messageSource - type: object properties: type: type: string enum: - appVersion op: type: string enum: - is - is-not description: '`is` matches any listed value. `is-not` matches none of them.' value: type: array items: type: string description: Ids to match. required: - type - op - value title: appVersion - type: object properties: type: type: string enum: - ticketReopened op: type: string enum: - is value: type: boolean required: - type - op - value title: ticketReopened - type: object properties: type: type: string enum: - hasCsatReview op: type: string enum: - is value: type: boolean required: - type - op - value title: hasCsatReview - type: object properties: type: type: string enum: - hasBeenAssistedByTheAssistant op: type: string enum: - is value: type: boolean required: - type - op - value title: hasBeenAssistedByTheAssistant - type: object properties: type: type: string enum: - csatSurveySent op: type: string enum: - is value: type: boolean required: - type - op - value title: csatSurveySent - type: object properties: type: type: string enum: - assigned op: type: string enum: - is value: type: boolean required: - type - op - value title: assigned - type: object properties: op: type: string enum: - greater-than - less-than - between value: anyOf: - type: number - type: object properties: type: type: string enum: - number-range min: type: number max: type: number required: - type - min - max type: type: string enum: - backlogWaitTime required: - op - value - type title: backlogWaitTime - type: object properties: op: type: string enum: - greater-than - less-than - between value: anyOf: - type: number - type: object properties: type: type: string enum: - number-range min: type: number max: type: number required: - type - min - max type: type: string enum: - firstResponseTime required: - op - value - type title: firstResponseTime - type: object properties: op: type: string enum: - greater-than - less-than - between value: anyOf: - type: number - type: object properties: type: type: string enum: - number-range min: type: number max: type: number required: - type - min - max type: type: string enum: - agentMessageCount required: - op - value - type title: agentMessageCount - type: object properties: op: type: string enum: - greater-than - less-than - between value: anyOf: - type: number - type: object properties: type: type: string enum: - number-range min: type: number max: type: number required: - type - min - max type: type: string enum: - customerMessageCount required: - op - value - type title: customerMessageCount - type: object properties: type: type: string enum: - bulkAction op: type: string enum: - is value: type: boolean required: - type - op - value title: bulkAction description: >- Limits which tickets count toward the stat. Note on the `field` filter: it uses operators based on its field type. Dropdowns use `include-any`, `include-all`, `exclude-any`, and `exclude-all`. Text uses `is`, `is-not`, `contains`, and `not-contains`. Numbers use `is`, `is-not`, `greater-than`, `less-than`, and `between`. Dates use `before`, `after`, and `between`. Boolean fields use `is` with `true` or `false`. Every field type also accepts `is-set` and `is-not-set`. StatsTimeframe: anyOf: - type: object properties: type: type: string enum: - TODAY required: - type title: Today - type: object properties: type: type: string enum: - PAST_7_DAYS required: - type title: Past 7 days - type: object properties: type: type: string enum: - PAST_30_DAYS required: - type title: Past 30 days - type: object properties: type: type: string enum: - PAST_90_DAYS required: - type title: Past 90 days - type: object properties: type: type: string enum: - PAST_365_DAYS required: - type title: Past 365 days - type: object properties: type: type: string enum: - CUSTOM from: anyOf: - type: string format: date - type: object properties: date: type: string format: date hours: type: integer minimum: 0 maximum: 23 description: Hour of the day, 0-23. required: - date - hours description: Inclusive start. A date, or a date plus an hour. to: anyOf: - type: string format: date - type: object properties: date: type: string format: date hours: type: integer minimum: 0 maximum: 23 description: Hour of the day, 0-23. required: - date - hours description: End. A date, or a date plus an hour. required: - type - from - to title: Custom description: Time range for the query. Preset ranges include the current day. StatsBreakdown: anyOf: - type: object properties: type: type: string enum: - TICKET_ID - ASSIGNEE - AGENT - ARTICLE - CHANNEL - CSAT - APP - LANGUAGE - PLATFORM - SUPPORT_SOURCE - STATUS - RESOLUTION_TYPE - CUSTOMER_TIER - TIME_TO_FIRST_RESPONSE_BUCKET - BACKLOG_WAIT_TIME_BUCKET - AVERAGE_TIME_TO_RESPONSE_FROM_EARLIEST_MSG_BUCKET - TIME_TO_RESOLUTION_BUCKET - TAG - TEAM - SKILL - TIME_HOUR - TIME_DAY - TIME_WEEK - TIME_WEEKDAY - TIME_MONTH - TIME_YEAR required: - type title: Other dimensions - type: object properties: type: type: string enum: - FIELD fieldKey: type: string description: Custom field key. fieldType: type: string enum: - text - date - boolean - dropdown - number required: - type - fieldKey - fieldType title: Field dimension description: One breakdown or segment. FIELD also requires fieldKey and fieldType. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.