Skip to main content
GET
Retrieve a report by ID

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Path Parameters

id
string<uuid>
required

Response

200 - application/json

OK

id
string<uuid>
required

ID

alertId
string<uuid>
required

Alert ID

contentHash
string
required

Content Hash

filename
string
required

Filename

contentType
string
required

Content Type

size
integer
required

Size

Required range: -9007199254740991 < x <= 9007199254740991
outputFormat
enum<string>
required

Output Format

Available options:
xml,
txt
sequence
integer
required

Sequence

Required range: -9007199254740991 < x <= 9007199254740991
totalParts
integer
required

Total Parts

Required range: -9007199254740991 < x <= 9007199254740991
isCurrent
boolean
required

Is Current

generatedAt
string<date-time>
required

Generated At

createdAt
string<date-time>
required

Created At

updatedAt
string<date-time>
required

Updated At

referenceNumber
string

Reference Number

name
string

Name

tags
object[]