Reports

Complete report generation

Callback from Ollie to update report status and content after generation.

post/v1/private/projects/{projectId}/reports/{reportId}/complete

Path parameters

projectIdstring uuid required
reportIdstring uuid required

Request body

contentstring
status'pending' | 'completed' | 'failed' required
session_idstring
recommended_actionsJsonNode
failure_reasonstring

Why the report failed. Only 'out_of_credits' is acted on; any other value is recorded but renders as a generic failure.

Response

Report updated

Changes

Changed in 3 of the 58 revisions of this API.23

  • bcd13aadaaf812See the full diff
    • request body became required

      request-body-became-required

    • added the new optional request property

      new-optional-request-property

    • added the non-success response with the status

      response-non-success-status-added

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

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