Get Report

get/api/reports/{reportId}

Retrieve a report by ID.

Use this endpoint to poll the status of a scheduled report. Once the status is completed, call Create Report Download URL to obtain a pre-signed URL for the report artifact.

Subscribing to the Report Completed webhook is the recommended alternative to polling.

Request

Path Parameters

reportIdstringrequired
The ID of the report to retrieve.

Response

Successful operation.

Body application/json

idstringrequired
The report ID.
typestringrequired
Allowed values:daily-funding-sourcemonthly-funding-sourcedaily-funding-source-interactionmonthly-funding-source-interactiondaily-paymentmonthly-payment
The report type.
accountIdstringrequired
The account the report belongs to.
scheduleDatestring<date-time>required
The ISO 8601 date-time the report is scheduled to be generated. This is not the period the report covers; see params.date for that.
paramsobjectrequired
The parameters the report was scheduled with. Fields present depend on the report type.
- partnerAccountIdstring
  The partner account the report covers. Present on all report types.
- datestring
  The period the report covers. Format is yyyyMMdd for daily reports and yyyyMM for monthly reports.
- fundingPurposestring
  Allowed values:card-fundingbilling
  Optional funding purpose filter. Only applies to funding-source and funding-source-interaction reports.
statusstringrequired
Allowed values:pendingcompleted
The processing status of the report.
When completed, use Create Report Download URL to retrieve the artifact.
livenessstringrequired
Allowed values:livetest
Whether the report covers live or test data.

Request fields are invalid.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
errorsobject[]
Items
- messagestring
- pathstring
  The location of the invalid path param, query param or payload attribute.

No authorization to access the report, or the report does not exist.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

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

Example Response

{
  "id": "01JPMK5BGDY7G2PQXYZ1234567",
  "type": "daily-payment",
  "accountId": "225d85e65495722bf6517ea0ba0d6f56",
  "scheduleDate": "2026-03-21T00:00:00.000Z",
  "params": {
    "partnerAccountId": "225d85e65495722bf6517ea0ba0d6f56",
    "date": "20260320",
    "fundingPurpose": "card-funding"
  },
  "status": "pending",
  "liveness": "live"
}

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

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