Dismiss an analytics Spotlight insight
Dismiss one active Analytics Spotlight insight for the current dashboard user for 30 days.
Endpoint
POST
/api/v1/workspaces/{workspace_id}/analytics/spotlight/{insight_key}/dismissAuthentication
| Operation class | Authentication | Minimum role | API key |
|---|---|---|---|
| dashboard-session-api | Dashboard session cookie; mutations also require X-CX-Request: 1. | member | Not allowed |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
workspace_id | path | string | Yes | — |
insight_key | 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
application/json request schema
| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
|---|---|---|---|---|---|---|---|
$ | object | DismissInsightBody | — | No | Yes | — | — |
agent_id | string | — | — | No | Yes | — | — |
Example
curl --request POST 'https://operade.ai/api/v1/workspaces/ws_demo/analytics/spotlight/repeated_runtime_errors%3Aagt_demo%3A0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef/dismiss?agent_id=agt_demo' \
--cookie 'cx_session=YOUR_SESSION_COOKIE' \
--header 'X-CX-Request: 1' \
--header 'Content-Type: application/json' \
--data '{"agent_id":"agt_demo"}'Responses
| Status | Description | Content |
|---|---|---|
4XX | Client Error | application/json: ErrorResponse |
204 | The insight was dismissed; no response body is returned. | No body |
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 | — | — |
Response example
HTTP 204 This response has no body.
Errors
Reviewed common and route-declared errors are summarized here; the list is not exhaustive. Start with the distributed error index 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. |