Insights

Mark an insight as read

Clears the insight from the unread badge count and returns the updated row. The insight itself stays in the feed.

API key scopes: insights:write. You also need an Idempotency-Key header.

post/api/insights/{id}/read

Request

  • Base URL: https://api.setluca.com
  • URL: https://api.setluca.com/api/insights/{id}/read
  • Auth: one of:
    • API key in cookie luca.session_token
    • API key in header x-api-key
    • HTTP bearer

Path parameters

idstring uuid required

Identifier of the insight this operation targets.

Headers

Luca-API-Version'1'

The major version of the API this client was built against. Omit it and the request is served by the current major version. Any other value is refused with 400 unsupported_api_version.

Response

ok

idstring uuid required
kind'metric_drop' | 'metric_spike' | 'opportunity' | 'milestone' | 'risk' required
severity'info' | 'warning' | 'urgent' required
metricstring required
titlestring required
bodystring required
currentValuenumber nullable required
previousValuenumber nullable required
deltaPctnumber nullable required
actionRoutestring nullable required
actionLabelstring nullable required
dedupeKeystring required
status'unread' | 'read' | 'dismissed' | 'actioned' | 'expired' required
detectedAtstring required
readAtstring nullable required
dismissedAtstring nullable required
expiresAtstring nullable required
createdAtstring required

Changes

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