Insights

Update Insight Status

Updates the display status (e.g. actionable, acknowledged, dismissed) of a single insight. Only insights created via the public API can have their status changed. Deprecated: use the status field on the create/update insight endpoint instead.

put/insights/v1/results/source/{sourceID}/insight/{insightKey}/status

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/insights/v1/results/source/{sourceID}/insight/{insightKey}/status
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Path parameters

sourceID'public-api' required

Only insights created via the public API can be managed. Currently only "public-api" is supported.

insightKeystring required

The unique key identifying the insight to update.

Request body

status'actionable' | 'acknowledged' | 'optimized' | 'dismissed' | 'in progress' | 'upgrade needed' | 'permissions needed' required

The display status of the insight.

Response

Status updated successfully

Changes

No recorded changes to this operation across all 1 revision of this API.