Sign in

v1

latestOpenAPI 3.0.32026-08-0658558.8 KB
Reports

Get a report

Here, you apply the report-id from the List reports operation as the path parameter to get a downloadlink containing the report.

Download the report at the link in the downloadLink field in the response.

get/v1/reports/{report-id}

Path parameters

report-idstring uuid required
Example:497f6eca-6276-4993-bfeb-53cbbbba6f08

Unique identifier for a report.

Response

Returns the JSON record of the report specified in the path parameter

reportIdstring uuid required

Unique identifier for a report.

reportNamestring

User defined name of the report.

reportType'PAYMENT_OPS' | 'RECON' | 'FAILURE_CONVERSION_SSA' required

The report type of the downloadable report.

reportFormat'CSV' | 'JSON' required

The report format of the downloadable report.

reportStatus'PENDING' | 'READY' | 'FAILED' | 'EMPTY' required

The status of the report.

startDatestring date-time required

The ISO-8601 start date (inclusive) for a requested report.

endDatestring date-time required

The ISO-8601 end date (inclusive) for a requested report.

Note: Must be after startDate, but no more than 90 days after.

createdOnstring date-time

Report creation time

downloadLinkstring uri

Link where you can download the report in the available format. This field is available when the report status is READY.

reportCreatedBystring

Identifies the entity that initiated the report creation.

ValueDescription
SCHEDULERAutomated system-generated report initiated by the scheduler.
APIUser-generated report initiated through the API.
[full name]Full name of the user who initiated the creation of the report through the UI.
nullLegacy support for older reports.

Example response

{
  "reportId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "reportName": "My custom report",
  "reportStatus": "READY",
  "startDate": "2018-04-06T19:33:35Z",
  "endDate": "2018-04-06T20:33:35Z",
  "createdOn": "2018-04-06T20:33:35Z",
  "downloadLink": "https://reporting-test.rnc.ripplenet.com/v1/reports/download/497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "reportCreatedBy": "Norma Jean"
}