Sign in
report-ai
trend-scans

Trigger Scan

Trigger a trend scan. Returns immediately with status='running'.

The actual 5-stage pipeline runs asynchronously via an arq task. Poll GET /trend-scans/{scan_id}/status to track progress.

post/api/v1/report-ai/trend-scans

Request body

report_agent_idstring uuid required
window_startstring date-time required
window_endstring date-time required

Response

Successful Response

idstring uuid required
tenant_idstring uuid required
report_agent_idstring uuid required
report_agent_namestring nullable
window_startstring date-time required
window_endstring date-time required
status'running' | 'completed' | 'failed' required

Lifecycle status of a trend scan run.

current_stagestring nullable required
triggered_by_user_idstring uuid nullable required
started_atstring date-time required
completed_atstring date-time nullable required
total_eligible_investigationsinteger required
total_investigations_scannedinteger required
excludedobject nullable required
cached_tag_countinteger required
fresh_tag_countinteger required
total_trends_foundinteger required
tagger_versionstring required
error_messagestring nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

Changed in 1 of the 4 revisions of this API.2

  • d65b8fefae342See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog