Skip to main content
POST
Create a report

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Body

application/json
name
string
required

Report name shown in the dashboard's report selector

Example:

"Credit review"

insights
object[]
required

Ordered layout of insight entries and groups rendered by the report

organizational
boolean
default:false

Share the report with every user in the organization instead of keeping it personal

Response

Report resource response

@context
string
default:/contexts/InsightReport
@id
string<iri-reference>

Report IRI reference

Example:

"/reports/91106968-1abd-4d64-85c1-4e73d96fb997"

@type
string
default:InsightReport

JSON-LD resource type

id
string<uuid>

Unique report ID

Example:

"91106968-1abd-4d64-85c1-4e73d96fb997"

name
string

Report name shown in the dashboard's report selector; built-in reports use stable names such as full_report

Example:

"Credit review"

builtIn
boolean

Whether the report is managed by Syntage; built-in reports are kept up to date automatically and cannot be modified or deleted

Example:

false

organizational
boolean

Whether the report is shared with every user in the organization; personal reports are only visible to their owner

Example:

false

insights
object[]

Ordered layout of insight entries and groups rendered by the report

createdBy
object

Profile of the user who created the report; omitted for built-in reports

createdAt
string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

updatedAt
string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"