alpha

Get reports

Get the status, immutable workflow version, and source labels of an Alpha report run by the runId its start returned. Carries no report content.

get/api/v1/alpha/reports/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/alpha/reports/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Path parameters

idstring uuid required

Alpha report ID (the report's run ID)

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

runIdstring uuid required

Alpha report ID (the report's run ID)

status'pending' | 'running' | 'succeeded' | 'failed' | 'cancelled' required
executionStatus'scheduled' | 'waiting' | 'running' | 'completed' | 'failed' | 'cancelled' required

The status in Point11's shared execution vocabulary, as every run badge shows it

workflowKeystring required

Published Alpha internal-report workflow key

workflowNamestring required
workflowVersionIdstring uuid required
workflowVersioninteger required
workflowPublishedAtstring date-time required
createdAtstring date-time required
startedAtstring date-time nullable required
completedAtstring date-time nullable required

Changes

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