Skip to main content
POST
/
firework
/
v4
/
threat_flow
/
reports
/
requests
Create Report Request
curl --request POST \
  --url https://api.flare.io/firework/v4/threat_flow/reports/requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "report_title": "<string>",
  "question": "<string>",
  "time_range_type": "all",
  "time_range_from": "2023-11-07T05:31:56Z",
  "time_range_to": "2023-11-07T05:31:56Z",
  "included_keywords": [
    "<string>"
  ],
  "excluded_keywords": [
    "<string>"
  ]
}
'
{
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

​
Guides

See the guide for using this endpoint: Generate a Threat Flow Report .

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
report_title
string
required
​
question
string | null
​
time_range_type
enum<string>
default:all
Available options:
all,
last_24h,
last_2d,
last_7d,
last_1m,
last_3m,
last_6m,
range
​
time_range_from
string<date-time> | null
​
time_range_to
string<date-time> | null
​
included_keywords
string[] | null
​
excluded_keywords
string[] | null

Response

Successful Response

​
request_id
string<uuid>
required