Get Reports

This API retrieves a list of reports along with their details, such as report type, status, timestamps, and download URL (if available).

Request

This API does not require a request body.

Response

The response is an array of report objects containing metadata about generated reports.

Response Fields

Field Name	Description
`id`	Unique identifier of the report.
`name`	The name of the generated report.
`reportType`	An object containing details about the type of report.
`reportType.id`	Unique identifier of the report type.
`reportType.name`	The name of the report type.
`reportType.featured`	Indicates if the report type is featured.
`reportType.deleted`	Indicates if the report type has been deleted.
`status`	The current status of the report (e.g., `PENDING`, `COMPLETED`, `FAILED`).
`createdAt`	The timestamp when the report was created.
`startedAt`	The timestamp when the report processing started.
`completedAt`	The timestamp when the report processing completed.
`url`	The URL to download the report (if available, otherwise `null`).

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

[
  {
    "id": 1,
    "name": "Test Report",
    "reportType": {
      "id": 1,
      "name": "MERCHANT TRANSACTIONS REPORT",
      "featured": "true",
      "deleted": false
    },
    "status": "FAILED",
    "createdAt": "2024-07-09T12:15:31.000+00:00",
    "startedAt": "2024-07-09T12:15:54.000+00:00",
    "completedAt": "2024-07-09T12:16:25.000+00:00",
    "url": null
  }
]

🟠401| Source | Error | When |

🔴500| Source | Error | When |

Request#

Response#

Response Fields#

Request

Request Code Samples

Responses

Request

Response

Response Fields