Skip to main content
GET
/
reports
/
{id}
Retrieve a report by ID
curl --request GET \
  --url https://api.artu.ai/reports/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Environment: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "alertId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contentHash": "<string>",
  "filename": "<string>",
  "contentType": "<string>",
  "size": 0,
  "sequence": 0,
  "totalParts": 0,
  "isCurrent": true,
  "generatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "referenceNumber": "<string>",
  "name": "<string>",
  "tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "color": "<string>"
    }
  ]
}

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[]