Sign in
Reports

Create a report

Submits a new report run for the specified report type and parameters. The report executes asynchronously; poll the returned report ID to check status.

post/v4/reports

Request body

display_namestring nullable required
format'CSV' | 'HEADLESS_CSV' | 'HEADLESS_PSV' | 'JSON' | 'JSONL' | 'PSV' | 'XLSX' nullable required
formatsstring[] nullable required
namestring required
parametersobject required
report_typestring required
rerunboolean nullable required
scopesstring[] nullable required
sftp_report_namestring nullable required
sftp_server_idstring nullable required
tagsstring[] nullable required

Response

Successful response

completed_datestring nullable required
display_namestring required
download_uristring nullable required
formatsstring[] required
namestring required
report_idstring required
report_typestring required
tagsstring[] required

Changes