# Get an analytics tab

Return the stable analytics envelope for the selected tab, window, granularity, filters, and supported grouping.

## Endpoint

`GET /api/v1/workspaces/{workspace_id}/analytics/tabs/{tab}`

## Authentication

| Class | Authentication | Minimum role | API key |
| --- | --- | --- | --- |
| customer-api | Bearer API key or dashboard session cookie; dashboard mutations also require X-CX-Request: 1. | member | Allowed |

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `workspace_id` | path | `string` | Yes | — |
| `tab` | path | `string` | Yes | — |
| `from` | query | `string or null` | No | — |
| `to` | query | `string or null` | No | — |
| `timezone` | query | `string or null` | No | — |
| `granularity` | query | `string or null` | No | — |
| `agent_id` | query | `string or null` | No | — |
| `branch_id` | query | `string or null` | No | — |
| `version_id` | query | `string or null` | No | — |
| `source` | query | `string or null` | No | — |
| `group_by` | query | `string or null` | No | — |

## Request body

This operation has no request body.

## Example

```bash
curl --request GET 'https://operade.ai/api/v1/workspaces/ws_demo/analytics/tabs/general?granularity=day' \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

## Responses

| Status | Description | Content |
| --- | --- | --- |
| 4XX | Client Error | application/json: `ErrorResponse` |
| 200 | Successful Response | application/json: `AnalyticsTabResponse` |

### 4XX application/json response schema

| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
| --- | --- | --- | --- | --- | --- | --- | --- |
| `$` | `object` | ErrorResponse | — | No | Yes | — | — |
| `error` | `object` | ErrorItem | — | No | Yes | — | — |
| `error.code` | `string` | — | — | No | Yes | — | — |
| `error.details` | `object` | — | — | No | No | — | — |
| `error.message` | `string` | — | — | No | Yes | — | — |

### 200 application/json response schema

| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
| --- | --- | --- | --- | --- | --- | --- | --- |
| `$` | `object` | AnalyticsTabResponse | — | No | Yes | — | Stable tab envelope whose metric, series, and table keys vary by tab. |
| `filters` | `object` | AnalyticsTabFilters | — | No | Yes | — | — |
| `filters.agent_id` | `string or null` | — | — | Yes | Yes | — | — |
| `filters.branch_id` | `string or null` | — | — | Yes | Yes | — | — |
| `filters.group_by` | `string or null` | — | — | Yes | Yes | — | — |
| `filters.source` | `string or null` | — | — | Yes | Yes | — | — |
| `filters.version_id` | `string or null` | — | — | Yes | Yes | — | — |
| `metrics` | `object` | — | — | No | Yes | — | — |
| `series` | `array<object>` | — | — | No | Yes | — | — |
| `series[]` | `object` | — | — | No | Yes | — | — |
| `tables` | `array<object>` | — | — | No | Yes | — | — |
| `tables[]` | `object` | — | — | No | Yes | — | — |
| `window` | `object` | AnalyticsTabWindow | — | No | Yes | — | — |
| `window.from` | `string` | — | date-time | No | Yes | — | — |
| `window.granularity` | `string` | — | — | No | Yes | — | — |
| `window.timezone` | `string` | — | — | No | Yes | — | — |
| `window.to` | `string` | — | date-time | No | Yes | — | — |

### Response example

```json
{
  "window": {
    "from": "2026-01-01T00:00:00Z",
    "to": "2026-01-01T00:00:00Z",
    "timezone": "string",
    "granularity": "string"
  },
  "filters": {
    "agent_id": "string",
    "branch_id": "string",
    "version_id": "string",
    "source": "string",
    "group_by": "string"
  },
  "metrics": {},
  "series": [],
  "tables": []
}
```

## Errors

Reviewed common and route-declared errors are summarized here; the list is not exhaustive. Start with the [distributed error index](/docs/reference/api/errors) to find each code's canonical domain page.

| Status | Code | Description |
| --- | --- | --- |
| 401 | `unauthenticated` | Authentication is missing, invalid, or revoked. |
| 403 | `forbidden` | The authenticated caller does not have access to this operation. |
| 404 | `not_found` | The requested workspace resource was not found. |
| 422 | `validation_failed` | The analytics window, filter combination, tab, grouping, or requested resource is invalid. |

## Related operations

- [Dismiss an analytics Spotlight insight](/docs/api-reference/analytics/dismiss-analytics-spotlight-insight) — `POST /api/v1/workspaces/{workspace_id}/analytics/spotlight/{insight_key}/dismiss`
- [Export an analytics tab](/docs/api-reference/analytics/export-analytics-tab) — `GET /api/v1/workspaces/{workspace_id}/analytics/tabs/{tab}/export`
- [Get agent topic analytics](/docs/api-reference/analytics/get-agent-topic-analytics) — `GET /api/v1/workspaces/{workspace_id}/agents/{agent_id}/topics`