---
title: "GET /api/v1/command-centre/analytics"
method: GET
path: "/api/v1/command-centre/analytics"
tags: ["analytics"]
---

# GET /api/v1/command-centre/analytics

`GET /api/v1/command-centre/analytics`

## Request

- Base URL: `https://api.clerkchat.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.clerkchat.co/api/v1/command-centre/analytics`
- Auth: none required

## Query parameters

- `from` string, required
- `to` string, required

## Response `200`

AnalyticsReport

- AnalyticsReportEncoded
  - `period` object, required
    - `from` integer, required
    - `to` integer, required
    - `timezone` string, required
  - `previousPeriod` object, required
    - `from` integer, required
    - `to` integer, required
    - `timezone` string, required
  - `timezone` object, required
    - `value` string, required
    - `source` 'organizationMetadata' | 'workspaceDefault', required
  - `granularity` 'hour' | 'day' | 'week', required
  - `metrics` object, required
    - `conversations` union, required
      - object
        - `_tag` 'available', required
        - `value` MetricValueEncoded, required
          - `current` number, required
          - `previous` number, nullable, required
          - `changePercent` number, nullable, required
      - object
        - `_tag` 'unavailable', required
        - `reason` union, required
          - object
            - `_tag` 'definitionPending', required
          - object
            - `_tag` 'insufficientData', required
            - `minimumSampleSize` integer, required
          - object
            - `_tag` 'notCollected', required
            - `source` 'conversationEvents' | 'workflowEvents' | 'responseEvents', required
    - `visitorMessages` union, required
      - object
        - `_tag` 'available', required
        - `value` MetricValueEncoded, required
          - `current` number, required
          - `previous` number, nullable, required
          - `changePercent` number, nullable, required
      - object
        - `_tag` 'unavailable', required
        - `reason` union, required
          - object
            - `_tag` 'definitionPending', required
          - object
            - `_tag` 'insufficientData', required
            - `minimumSampleSize` integer, required
          - object
            - `_tag` 'notCollected', required
            - `source` 'conversationEvents' | 'workflowEvents' | 'responseEvents', required
    - `aiMessages` union, required
      - object
        - `_tag` 'available', required
        - `value` MetricValueEncoded, required
          - `current` number, required
          - `previous` number, nullable, required
          - `changePercent` number, nullable, required
      - object
        - `_tag` 'unavailable', required
        - `reason` union, required
          - object
            - `_tag` 'definitionPending', required
          - object
            - `_tag` 'insufficientData', required
            - `minimumSampleSize` integer, required
          - object
            - `_tag` 'notCollected', required
            - `source` 'conversationEvents' | 'workflowEvents' | 'responseEvents', required
    - `humanMessages` union, required
      - object
        - `_tag` 'available', required
        - `value` MetricValueEncoded, required
          - `current` number, required
          - `previous` number, nullable, required
          - `changePercent` number, nullable, required
      - object
        - `_tag` 'unavailable', required
        - `reason` union, required
          - object
            - `_tag` 'definitionPending', required
          - object
            - `_tag` 'insufficientData', required
            - `minimumSampleSize` integer, required
          - object
            - `_tag` 'notCollected', required
            - `source` 'conversationEvents' | 'workflowEvents' | 'responseEvents', required
    - `averageMessagesPerConversation` union, required
      - object
        - `_tag` 'available', required
        - `value` MetricValueEncoded, required
          - `current` number, required
          - `previous` number, nullable, required
          - `changePercent` number, nullable, required
      - object
        - `_tag` 'unavailable', required
        - `reason` union, required
          - object
            - `_tag` 'definitionPending', required
          - object
            - `_tag` 'insufficientData', required
            - `minimumSampleSize` integer, required
          - object
            - `_tag` 'notCollected', required
            - `source` 'conversationEvents' | 'workflowEvents' | 'responseEvents', required
    - `takeovers` union, required
      - object
        - `_tag` 'available', required
        - `value` MetricValueEncoded, required
          - `current` number, required
          - `previous` number, nullable, required
          - `changePercent` number, nullable, required
      - object
        - `_tag` 'unavailable', required
        - `reason` union, required
          - object
            - `_tag` 'definitionPending', required
          - object
            - `_tag` 'insufficientData', required
            - `minimumSampleSize` integer, required
          - object
            - `_tag` 'notCollected', required
            - `source` 'conversationEvents' | 'workflowEvents' | 'responseEvents', required
    - `takeoverRate` union, required
      - object
        - `_tag` 'available', required
        - `value` MetricValueEncoded, required
          - `current` number, required
          - `previous` number, nullable, required
          - `changePercent` number, nullable, required
      - object
        - `_tag` 'unavailable', required
        - `reason` union, required
          - object
            - `_tag` 'definitionPending', required
          - object
            - `_tag` 'insufficientData', required
            - `minimumSampleSize` integer, required
          - object
            - `_tag` 'notCollected', required
            - `source` 'conversationEvents' | 'workflowEvents' | 'responseEvents', required
    - `containmentRate` union, required
      - object
        - `_tag` 'available', required
        - `value` MetricValueEncoded, required
          - `current` number, required
          - `previous` number, nullable, required
          - `changePercent` number, nullable, required
      - object
        - `_tag` 'unavailable', required
        - `reason` union, required
          - object
            - `_tag` 'definitionPending', required
          - object
            - `_tag` 'insufficientData', required
            - `minimumSampleSize` integer, required
          - object
            - `_tag` 'notCollected', required
            - `source` 'conversationEvents' | 'workflowEvents' | 'responseEvents', required
    - `firstResponseTime` union, required
      - object
        - `_tag` 'available', required
        - `value` MetricValueEncoded, required
          - `current` number, required
          - `previous` number, nullable, required
          - `changePercent` number, nullable, required
      - object
        - `_tag` 'unavailable', required
        - `reason` union, required
          - object
            - `_tag` 'definitionPending', required
          - object
            - `_tag` 'insufficientData', required
            - `minimumSampleSize` integer, required
          - object
            - `_tag` 'notCollected', required
            - `source` 'conversationEvents' | 'workflowEvents' | 'responseEvents', required
    - `pendingHuman` union, required
      - object
        - `_tag` 'available', required
        - `value` MetricValueEncoded, required
          - `current` number, required
          - `previous` number, nullable, required
          - `changePercent` number, nullable, required
      - object
        - `_tag` 'unavailable', required
        - `reason` union, required
          - object
            - `_tag` 'definitionPending', required
          - object
            - `_tag` 'insufficientData', required
            - `minimumSampleSize` integer, required
          - object
            - `_tag` 'notCollected', required
            - `source` 'conversationEvents' | 'workflowEvents' | 'responseEvents', required
    - `activeAgents` union, required
      - object
        - `_tag` 'available', required
        - `value` MetricValueEncoded, required
          - `current` number, required
          - `previous` number, nullable, required
          - `changePercent` number, nullable, required
      - object
        - `_tag` 'unavailable', required
        - `reason` union, required
          - object
            - `_tag` 'definitionPending', required
          - object
            - `_tag` 'insufficientData', required
            - `minimumSampleSize` integer, required
          - object
            - `_tag` 'notCollected', required
            - `source` 'conversationEvents' | 'workflowEvents' | 'responseEvents', required
  - `allTime` RetainedAllTimeAnalyticsEncoded, required
    - `retention` 'incompleteHistory', required
    - `projectionStartedAt` integer, nullable, required
    - `metrics` object, required
      - `conversations` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `visitorMessages` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `aiMessages` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `humanMessages` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `averageMessagesPerConversation` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `takeovers` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `takeoverRate` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `containmentRate` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `firstResponseTime` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `pendingHuman` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `activeAgents` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
  - `volume` AnalyticsVolumeBucketEncoded[], required
    - `conversations` TimeBucketEncoded, required
      - `start` integer, required
      - `end` integer, required
      - `value` number, required
    - `visitorMessages` TimeBucketEncoded, required
      - `start` integer, required
      - `end` integer, required
      - `value` number, required
    - `aiMessages` TimeBucketEncoded, required
      - `start` integer, required
      - `end` integer, required
      - `value` number, required
  - `peakHours` object[], required
    - `hour` integer, required
    - `count` number, required
  - `agents` AnalyticsAgentRowEncoded[], required
    - `agentId` string, required
    - `metrics` object, required
      - `conversations` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `visitorMessages` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `aiMessages` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `humanMessages` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `averageMessagesPerConversation` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `takeovers` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `takeoverRate` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `containmentRate` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `firstResponseTime` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `pendingHuman` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
      - `activeAgents` union, required
        - object
          - `_tag` 'available', required
          - `value` MetricValueEncoded, required
            - `current` number, required
            - `previous` number, nullable, required
            - `changePercent` number, nullable, required
        - object
          - `_tag` 'unavailable', required
          - `reason` union, required
            - object
              - …
            - object
              - …
            - object
              - …
  - `recentConversations` RecentConversationEncoded[], required
    - `conversationId` string, required
    - `agentId` string, required
    - `status` 'open' | 'closed', required
    - `control` 'ai' | 'human', required
    - `assigneeId` string, nullable, required
    - `lastActivityAt` integer, required
  - `freshness` union, required
    - object
      - `_tag` 'fresh', required
      - `asOf` integer, required
    - object
      - `_tag` 'stale', required
      - `asOf` integer, required
    - object
      - `_tag` 'unknown', required
  - `access` union, required
    - object
      - `_tag` 'agent', required
      - `agentId` string, required
    - object
      - `_tag` 'workspace', required
      - `visibleAgentCount` number, required
    - object
      - `_tag` 'permittedAgents', required
      - `agentIds` string[], required
      - `visibleAgentCount` number, required

## Other responses

- `400`: BadRequest
- `401`: Unauthorized
- `403`: Forbidden
- `404`: NotFound
- `503`: PersistenceUnavailable

---

[API](https://skmtc.dev/clerkchat/apis/clerk-chat-api.md) · [All operations](https://skmtc.dev/clerkchat/apis/clerk-chat-api/llms.txt) · [OpenAPI document](https://skmtc.dev/clerkchat/apis/clerk-chat-api/revisions/cc318e39e1d0?raw)