Skip to main content
POST
Create a report

Authorizations

Authorization
string
header
required

Body

application/json
display_name
string | null
required
format
enum<string> | null
required
Available options:
CSV,
HEADLESS_CSV,
HEADLESS_PSV,
JSON,
JSONL,
PSV,
XLSX
formats
enum<string>[] | null
required
Available options:
CSV,
HEADLESS_CSV,
HEADLESS_PSV,
JSON,
JSONL,
PSV,
XLSX
name
string
required
parameters
object
required
report_type
string
required
rerun
boolean | null
required
scopes
enum<string>[] | null
required
Available options:
CLIENT_ADMIN,
CLIENT_SUPERUSER,
CONSUMER_PUBLIC
sftp_report_name
string | null
required
sftp_server_id
string | null
required
tags
string[] | null
required

Response

Successful response

completed_date
string | null
required
display_name
string
required
download_uri
string | null
required
formats
enum<string>[]
required
Available options:
CSV,
HEADLESS_CSV,
HEADLESS_PSV,
JSON,
JSONL,
PSV,
XLSX
name
string
required
report_id
string
required
report_type
string
required
tags
string[]
required