Skip to main content
POST
/
v1
/
reports
Create Report
curl --request POST \
  --url https://api.example.com/v1/reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "format": "pdf",
  "window": {
    "from": "<string>",
    "to": "<string>"
  },
  "filters": {
    "pattern_id": "<string>",
    "team": "<string>",
    "domain": "<string>",
    "severity": "<string>",
    "source": "<string>"
  }
}
'
{}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
type
enum<string>
required
Available options:
risk_summary,
pattern_analysis,
prediction_forecast,
recommendations,
audit_trail,
executive_briefing
​
title
string | null
Maximum string length: 200
​
format
enum<string>
default:pdf
Available options:
csv,
xlsx,
json,
pdf,
pptx,
parquet
​
window
ReportWindow · object
​
filters
GenerateFilters · object

Response

Successful Response

The response is of type Response Create Report V1 Reports Post · object.