Get Reports

This endpoint retrieves a list of available reports. Reports provide insights into various system activities, such as merchant transactions. If a report is successfully generated, a download URL may be provided.

Response Body

Field Name	Type	Description
`id`	`integer`	Unique identifier of the report.
`name`	`string`	The name of the report, which describes its purpose or category.
`reportType`	`object`	Contains metadata about the report type.
`reportType.id`	`integer`	Unique identifier of the report type.
`reportType.name`	`string`	Name of the report type, such as "Merchant Transactions Report."
`reportType.featured`	`string`	Indicates whether the report type is featured (`true` or `false`).
`reportType.deleted`	`boolean`	Indicates whether the report type has been deleted.
`status`	`string`	The current status of the report: - `PENDING`: The report is queued for processing. - `IN_PROGRESS`: The report is being generated. - `FAILED`: The report generation process failed. - `COMPLETED`: The report was successfully generated.
`createdAt`	`string`	Timestamp indicating when the report was requested (ISO 8601 format).
`startedAt`	`string`	Timestamp indicating when the report generation process began.
`completedAt`	`string`	Timestamp indicating when the report generation process was completed.
`url`	`string`	Download link for the generated report (if available, otherwise `null`).

This version provides more clarity on what the API does, what the fields mean, and how they relate to the report lifecycle. Let me know if you need any refinements! 🚀

Responses

🟢200Get Reports

application/json

Body

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

Response Body

Request

Request samples

Responses

Get Reports

Response Body#

Request

Request samples

Responses

Response Body