Advisor

Create or Update Application Advisor Insight

Required scopes: project.advisor (Read and Write).

Called by an installed application's advisor-inspector module to publish the result of its own check against a string. Subsequent calls for the same string overwrite the previous insight from this module.

put/projects/{projectId}/applications/{applicationIdentifier}/modules/{moduleKey}/advisors/insights

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

applicationIdentifierstring required
moduleKeystring required

Request body

outcome'flagged' | 'clear' | 'not_applicable' required

Result of the app's check. flagged — issue detected; clear — on target; not_applicable — inspector does not apply to this project.

checkedAtstring date-time

Date when the app performed this check (ISO 8601). Defaults to the time the request is received.

payloadobject

Free-form data the app wants to keep attached to this insight. Stored as-is — the backend does not interpret its contents.

Example request

{
  "checkedAt": "2026-05-21T14:30:00+00:00",
  "metrics": [
    {
      "key": "quality_score",
      "value": 12,
      "unit": "percent",
      "threshold": 50,
      "tone": "danger",
      "source": "deterministic",
      "checkedAt": "2026-04-06T10:30:00+00:00"
    }
  ],
  "recommendations": [
    {
      "id": "run_ai_context_validation",
      "primary": true
    }
  ]
}

Response

Advisor insight updated

Changes

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