Reporting

List all Reports

Changed on

List key data of Reporting Service reports

get/v2.01/{ClientId}/reporting/reports

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/reporting/reports
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

Query parameters

Statusstring

Possible values: PENDING, GENERATING, GENERATED, EXPIRED, FAILED

The status of the report:

  • PENDING – The report generation request was accepted but is not yet being processed.
  • GENERATING – The report is being generated.
  • GENERATED – The report is ready for download at the DownloadURL
  • EXPIRED – The report has expired and is no longer available for download.
  • FAILED – Report generation was not successful.
BeforeDateinteger

The date before which the report was created (based on the report's CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

AfterDateinteger

The date after which the report was created (based on the report's CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

per_pageinteger

Min. value: 1; max. value: 100

Default value: 10

Indicates the number of items returned for each page of the pagination.

pageinteger

Start value: 1

Default value: 1

Indicates the index of the page for the pagination.

Sortstring

Possible values: CreationDate:ASC, CreationDate:DESC

Default value: CreationDate:ASC

Indicates the direction in which to sort the list.

Response

Success

Changes