Get Reports#
Retrieves the reports that have been requested, newest first, with their generation status and download link once complete.Response#
The response is a JSON array of report objects.| Field Name | Type | Description |
|---|
| id | integer | Unique identifier of the report. |
| name | string | Name given to the report when it was requested. |
| reportType | object | Report type: id, name, featured, deleted. |
| status | string | Generation status, for example PENDING, COMPLETED or FAILED. |
| createdAt | string | When the report was requested. |
| startedAt | string | When generation started. Absent until it starts. |
| completedAt | string | When generation finished. Absent until it finishes. |
| url | string | Download link, present once the report is complete. |
Request
Add the parameter Authorization
to Headers，whose value is to concatenate the Token after the Bearer. Example:Authorization: Bearer ********************
Token URL: {{tpGatewayHostUrl}}/security/authenticate
or
Request Code Samples
curl --location '/admin/reporting'
Responses
[
{
"id": 21,
"name": "Monthly Inward Transfers",
"reportType": {
"id": 1,
"name": "MERCHANT TRANSACTIONS REPORT",
"featured": "true",
"deleted": false
},
"status": "COMPLETED",
"createdAt": "2025-01-05T09:15:31.000+00:00",
"startedAt": "2025-01-05T09:15:54.000+00:00",
"completedAt": "2025-01-05T09:16:25.000+00:00",
"url": "https://example.com/reports/monthly-inward-transfers.xlsx"
},
{
"id": 20,
"name": "Test Report",
"reportType": {
"id": 1,
"name": "MERCHANT TRANSACTIONS REPORT",
"featured": "true",
"deleted": false
},
"status": "PENDING",
"createdAt": "2025-01-04T14:02:11.000+00:00"
}
]
Modified at 2026-11-02 12:41:40
