# List analytics Spotlight insights

List ranked, evidence-backed Analytics Spotlight insights for the requested window and filters, excluding insights dismissed by the current user.

## Endpoint

`GET /api/v1/workspaces/{workspace_id}/analytics/spotlight`

## 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 | — |
| `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 | — |

## Request body

This operation has no request body.

## Example

```bash
curl --request GET 'https://operade.ai/api/v1/workspaces/ws_demo/analytics/spotlight?agent_id=agt_demo' \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

## Responses

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

### 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` | AnalyticsSpotlightResponse | — | No | Yes | — | — |
| `insights` | `array<AnalyticsSpotlightInsight>` | — | — | No | Yes | — | — |
| `insights[]` | `object` | AnalyticsSpotlightInsight | — | No | Yes | — | — |
| `insights[].agent_id` | `string` | — | — | No | Yes | — | — |
| `insights[].agent_name` | `string` | — | — | No | Yes | — | — |
| `insights[].current_value` | `number or null` | — | — | Yes | Yes | — | — |
| `insights[].denominator` | `integer` | — | — | No | Yes | — | — |
| `insights[].description` | `string` | — | — | No | Yes | — | — |
| `insights[].evidence` | `object` | — | — | No | Yes | — | — |
| `insights[].evidence_count` | `integer` | — | — | No | Yes | — | — |
| `insights[].insight_key` | `string` | — | — | No | Yes | — | — |
| `insights[].numerator` | `integer` | — | — | No | Yes | — | — |
| `insights[].previous_value` | `number or null` | — | — | Yes | Yes | — | — |
| `insights[].rule` | `string` | — | — | No | Yes | "repeated_runtime_errors", "repeated_tool_errors", "max_duration_endings", "success_regression" | — |
| `insights[].severity` | `string` | — | — | No | Yes | "medium", "high" | — |
| `insights[].title` | `string` | — | — | No | Yes | — | — |
| `insights[].window` | `object` | AnalyticsTimeRange | — | No | Yes | — | — |
| `insights[].window.from` | `string` | — | date-time | No | Yes | — | — |
| `insights[].window.to` | `string` | — | date-time | No | Yes | — | — |
| `window` | `object` | AnalyticsTimeRange | — | No | Yes | — | — |
| `window.from` | `string` | — | date-time | 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"
  },
  "insights": []
}
```

## 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`
