curl -X GET "https://parsagon.io/api/events/v1/reports/12345/" \
-H "Authorization: Token YOUR_API_KEY_HERE"
{
"id": {},
"type": "<string>",
"fields": {},
"created_at": "<string>",
"finished_at": {},
"result": {},
"progress": 123,
"error": {},
"uuid": "<string>",
"is_test": true
}Endpoints
Retrieve report
Retrieve the current state of a previously created Report, including generated report content when available.
curl -X GET "https://parsagon.io/api/events/v1/reports/12345/" \
-H "Authorization: Token YOUR_API_KEY_HERE"
{
"id": {},
"type": "<string>",
"fields": {},
"created_at": "<string>",
"finished_at": {},
"result": {},
"progress": 123,
"error": {},
"uuid": "<string>",
"is_test": true
}Retrieve the current state of a previously created Report. Poll this endpoint after creating a report to check whether processing is complete.
Reports are processed asynchronously. Poll until
result or error is non-null.Path parameters
string
required
The
id returned when the Report was created.Response
Returns a JSON object representing the Report, including metadata and generated content when available.For Reports created with
is_test: true, this endpoint returns the dummy result stored at creation time.number | string
Unique identifier for the Report.
string
Report type.
object
Stored request fields.
string
Timestamp when the Report was created (ISO 8601, UTC).
string | null
Timestamp when report generation finished, or
null while processing.object | null
Generated report content when processing is complete,
null otherwise. For test reports, this is the built-in example result or the value provided in test_data.result.number
Processing progress from
0 to 100.string | null
Error message if report generation failed; otherwise
null.string
Public UUID for the Report.
boolean
Whether the Report was created in test mode.
curl -X GET "https://parsagon.io/api/events/v1/reports/12345/" \
-H "Authorization: Token YOUR_API_KEY_HERE"