> ## Documentation Index > Fetch the complete documentation index at: https://docs.getarbol.com/llms.txt > Use this file to discover all available pages before exploring further. # Query analytics > Returns only the requested tenant-scoped analytics sections under analytics:read and resolves their shared time window once. It performs no writes and is safe to retry with the same body. ## OpenAPI ````yaml https://api.getarbol.com/openapi.json post /analytics/query openapi: 3.1.2 info: contact: email: support@getarbol.com name: Arbol url: https://docs.getarbol.com description: >- Provider-neutral API for creating and operating Arbol agents, contacts, conversations, channels, knowledge, integrations, and evaluations. Every request is bound to one Auth0 Organization. title: Arbol API version: 1.0.0 servers: - description: Production url: https://api.getarbol.com/v1 security: [] paths: /analytics/query: post: tags: - Analytics summary: Query analytics description: >- Returns only the requested tenant-scoped analytics sections under analytics:read and resolves their shared time window once. It performs no writes and is safe to retry with the same body. operationId: queryAnalytics requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AnalyticsQueryInput' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AnalyticsQueryResult' headers: X-Request-Id: $ref: '#/components/headers/RequestId' '400': description: >- Inferable validation failure or a non-inferable malformed transport request. content: application/json: schema: oneOf: - oneOf: - $ref: '#/components/schemas/BadRequest' - $ref: '#/components/schemas/UndefinedError' - $ref: '#/components/schemas/TransportBadRequestError' headers: X-Request-Id: $ref: '#/components/headers/RequestId' '401': description: Authentication is required. content: application/json: schema: oneOf: - $ref: '#/components/schemas/Unauthorized' - $ref: '#/components/schemas/UndefinedError' headers: X-Request-Id: $ref: '#/components/headers/RequestId' '403': description: The caller is not allowed to perform this operation. content: application/json: schema: oneOf: - $ref: '#/components/schemas/Forbidden' - $ref: '#/components/schemas/UndefinedError' headers: X-Request-Id: $ref: '#/components/headers/RequestId' '413': $ref: '#/components/responses/TransportPayloadTooLarge' '415': $ref: '#/components/responses/TransportUnsupportedMediaType' security: - userOAuth: - org:use - analytics:read - machineOAuth: - analytics:read components: schemas: AnalyticsQueryInput: type: object properties: agentId: $ref: '#/components/schemas/ArbolResourceId' channelKind: $ref: '#/components/schemas/ChannelKind' from: $ref: '#/components/schemas/IsoDatetime' granularity: $ref: '#/components/schemas/AnalyticsGranularity' metric: $ref: '#/components/schemas/AnalyticsMetric' default: conversations sections: minItems: 1 maxItems: 4 type: array items: $ref: '#/components/schemas/AnalyticsSection' timezone: default: UTC type: string const: UTC to: $ref: '#/components/schemas/IsoDatetime' required: - sections additionalProperties: false description: >- A bounded set of analytics projections over one shared half-open time window. examples: - granularity: day metric: conversations sections: - summary - chart timezone: UTC title: Analytics query AnalyticsQueryResult: type: object properties: agentPerformance: maxItems: 500 type: array items: type: object properties: agentId: $ref: '#/components/schemas/ArbolResourceId' averageDurationSeconds: type: number minimum: 0 conversations: type: integer minimum: 0 maximum: 9007199254740991 lastActiveAt: anyOf: - $ref: '#/components/schemas/IsoDatetime' - type: 'null' name: type: string minLength: 1 maxLength: 200 successRate: type: number minimum: 0 maximum: 1 required: - agentId - averageDurationSeconds - conversations - lastActiveAt - name - successRate additionalProperties: false chart: type: object properties: metric: $ref: '#/components/schemas/AnalyticsMetric' points: maxItems: 10000 type: array items: type: object properties: date: type: string minLength: 1 maxLength: 64 value: type: number required: - date - value additionalProperties: false required: - metric - points additionalProperties: false statusBreakdown: maxItems: 50 type: array items: type: object properties: count: type: integer minimum: 0 maximum: 9007199254740991 key: type: string minLength: 1 maxLength: 100 required: - count - key additionalProperties: false summary: type: object properties: averageDurationSeconds: type: number minimum: 0 contacts: type: integer minimum: 0 maximum: 9007199254740991 conversations: type: integer minimum: 0 maximum: 9007199254740991 messages: type: integer minimum: 0 maximum: 9007199254740991 successRate: type: number minimum: 0 maximum: 1 required: - averageDurationSeconds - contacts - conversations - messages - successRate additionalProperties: false window: type: object properties: from: $ref: '#/components/schemas/IsoDatetime' granularity: $ref: '#/components/schemas/AnalyticsGranularity' timezone: type: string const: UTC to: $ref: '#/components/schemas/IsoDatetime' required: - from - granularity - timezone - to additionalProperties: false required: - window additionalProperties: false description: >- Only the requested analytics sections, all resolved over the same returned window. title: Analytics query result BadRequest: type: object properties: defined: const: true inferable: type: boolean code: const: BAD_REQUEST status: const: 400 message: type: string data: type: object properties: issues: maxItems: 20 type: array items: type: object properties: message: type: string maxLength: 500 path: maxItems: 16 type: array items: anyOf: - type: string maxLength: 120 - type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - message additionalProperties: false truncated: type: boolean required: - issues - truncated additionalProperties: false required: - defined - inferable - code - status - message - data UndefinedError: type: object properties: defined: const: false inferable: type: boolean code: type: string status: type: number message: type: string data: {} required: - defined - inferable - code - status - message TransportBadRequestError: additionalProperties: false properties: code: const: BAD_REQUEST data: {} defined: const: false inferable: const: false message: type: string required: - defined - inferable - code - message type: object Unauthorized: type: object properties: defined: const: true inferable: type: boolean code: const: UNAUTHORIZED status: const: 401 message: type: string data: {} required: - defined - inferable - code - status - message Forbidden: type: object properties: defined: const: true inferable: type: boolean code: const: FORBIDDEN status: const: 403 message: type: string data: type: object properties: missingPermissions: maxItems: 10 type: array items: $ref: '#/components/schemas/AuthPermission' required: - missingPermissions additionalProperties: false required: - defined - inferable - code - status - message ArbolResourceId: type: string maxLength: 64 pattern: >- ^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ description: >- Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type. examples: - agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31 title: Arbol resource ID ChannelKind: type: string enum: - voice - whatsapp - telegram - slack - email - web description: Conversation transport family. examples: - voice title: Channel kind IsoDatetime: 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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ description: ISO 8601 timestamp with an explicit UTC offset. examples: - '2026-08-29T14:30:00Z' title: ISO timestamp AnalyticsGranularity: type: string enum: - hour - day - week - month description: Bucket size used for an analytics chart window. examples: - day title: Analytics granularity AnalyticsMetric: type: string enum: - conversations - messages - duration - success_rate description: Measure aggregated into analytics chart points. examples: - conversations title: Analytics metric AnalyticsSection: type: string enum: - summary - chart - statusBreakdown - agentPerformance description: Typed projection requested from the analytics query. examples: - summary title: Analytics section AuthPermission: type: string enum: - agent-evaluations:read - agent-evaluations:run - agent-evaluations:write - agents:read - agents:write - analytics:read - arbi:use - channels:read - channels:write - contacts:read - contacts:write - conversations:read - conversations:transcript - conversations:write - definitions:read - definitions:write - facts:read - facts:write - integrations:read - integrations:write - knowledge:read - knowledge:write - org:manage - org:use description: >- One permission from the closed Arbol API vocabulary accepted from a verified Auth0 token. examples: - agents:read title: API permission TransportPayloadTooLargeError: additionalProperties: false properties: code: const: PAYLOAD_TOO_LARGE data: {} defined: const: false inferable: const: false message: type: string required: - defined - inferable - code - message type: object TransportUnsupportedMediaTypeError: additionalProperties: false properties: code: const: UNSUPPORTED_MEDIA_TYPE data: {} defined: const: false inferable: const: false message: type: string required: - defined - inferable - code - message type: object headers: RequestId: description: >- Opaque request correlation identifier. Include it when contacting Arbol support. schema: type: string maxLength: 128 responses: TransportPayloadTooLarge: content: application/json: schema: $ref: '#/components/schemas/TransportPayloadTooLargeError' description: The request body exceeds the API transport limit. headers: X-Request-Id: $ref: '#/components/headers/RequestId' TransportUnsupportedMediaType: content: application/json: schema: $ref: '#/components/schemas/TransportUnsupportedMediaTypeError' description: The request media type is not supported. headers: X-Request-Id: $ref: '#/components/headers/RequestId' securitySchemes: userOAuth: description: >- Organization-scoped Auth0 user access token issued to an approved first-party client or exchanged by a trusted OBO resource server. flows: authorizationCode: authorizationUrl: https://auth.getarbol.com/authorize scopes: agent-evaluations:read: Read Agent evaluation suites, runs, and results. agent-evaluations:run: Execute and cancel Agent evaluation runs. agent-evaluations:write: Create and update Agent evaluation suites. agents:read: Read Agents and their explicitly requested expansions. agents:write: Create, update, and delete Agents. analytics:read: Read organization analytics. arbi:use: Use the personal Arbi workspace. channels:read: Read Agent channels. channels:write: Create, update, authorize, and delete Agent channels. contacts:read: Read Contacts and their explicitly requested expansions. contacts:write: Create, update, merge, import, and delete Contacts. conversations:read: Read Conversation metadata. conversations:transcript: Read Conversation messages and media evidence. conversations:write: Create and process Conversations. definitions:read: Read Definitions and Definition usage. definitions:write: Create, update, and retire Definitions. facts:read: Read current and historical Facts. facts:write: Assert typed Facts. integrations:read: Discover integrations, tools, accounts, and tool-bearing evidence. integrations:write: Authorize accounts and assign exact tool access. knowledge:read: Read Knowledge documents and search indexed content. knowledge:write: Create, index, update, and delete Knowledge documents. org:manage: Update the Organization and administer its members. org:use: Use Arbol as a member of the selected Auth0 Organization. tokenUrl: https://auth.getarbol.com/oauth/token type: oauth2 machineOAuth: description: >- Organization-bound Auth0 client-credentials token. The client grant must contain every operation scope. flows: clientCredentials: scopes: agent-evaluations:read: Read Agent evaluation suites, runs, and results. agent-evaluations:run: Execute and cancel Agent evaluation runs. agent-evaluations:write: Create and update Agent evaluation suites. agents:read: Read Agents and their explicitly requested expansions. agents:write: Create, update, and delete Agents. analytics:read: Read organization analytics. channels:read: Read Agent channels. channels:write: Create, update, authorize, and delete Agent channels. contacts:read: Read Contacts and their explicitly requested expansions. contacts:write: Create, update, merge, import, and delete Contacts. conversations:read: Read Conversation metadata. conversations:transcript: Read Conversation messages and media evidence. conversations:write: Create and process Conversations. definitions:read: Read Definitions and Definition usage. definitions:write: Create, update, and retire Definitions. facts:read: Read current and historical Facts. facts:write: Assert typed Facts. integrations:read: Discover integrations, tools, accounts, and tool-bearing evidence. integrations:write: Authorize accounts and assign exact tool access. knowledge:read: Read Knowledge documents and search indexed content. knowledge:write: Create, index, update, and delete Knowledge documents. org:manage: Update the Organization and administer its members. tokenUrl: https://auth.getarbol.com/oauth/token type: oauth2 ````