Create Report Download URL

post/api/reports/{reportId}/download

Create a pre-signed URL to download a report.

After receiving the webhook Report Completed, call this endpoint to generate a short-lived pre-signed URL for the report artifact.

If the URL expires before you use it, call the endpoint again to generate a new one for the same report.

Request

Path Parameters

reportIdstringrequired
The ID of the report to download.

Response

Download URL successfully generated.

Body application/json

reportIdstringrequired
The ID of the report.
downloadUrlstringrequired
A pre-signed S3 URL to download the report artifact. Valid for 24 hours.
expiresAtstring<date-time>required
The ISO 8601 timestamp at which the download URL expires.

Subject is not allowed to perform the action with the reason stated in the errorCode.

FORBIDDEN The caller is not authorized to access the report, or the report artifact is not available for download.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/reports/{reportId}/download' \
  --request POST \
  --header 'Authorization: Bearer <access-token>'

curl 'https://api.immersve.com/api/reports/{reportId}/download' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>'

curl 'https://test.immersve.com/api/reports/{reportId}/download' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>'

Example Response

{
  "reportId": "01JPMK5BGDY7G2PQXYZ1234567",
  "downloadUrl": "https://s3.amazonaws.com/immersve-reports/report.jsonl?X-Amz-Signature=...",
  "expiresAt": "2026-03-22T10:00:00.000Z"
}

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}