Skip to main content
POST
Create Report

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Api-key
string | null

Query Parameters

active_workspace_id
string<uuid> | null
parent_folder_id
string<uuid> | null

Body

application/json
title
string
required
content
string
required
Maximum string length: 100000
context
string | null

JSON string referencing datasets/dashboards/pipelines relevant to this report

job_id
string<uuid> | null

ID of the job template that generated this report

job_run_id
string<uuid> | null

ID of the specific job run that generated this report

Response

Successful Response

id
string<uuid>
required
created_at
string<date-time>
required
title
string
required
content
string
required
context
string | null
required
job_id
string<uuid> | null
job_run_id
string<uuid> | null
current_version_id
string<uuid> | null