Skip to main content

Retrieve report details

You can retrieve the details of all reports or a singular report using the following methods:

  • Retrieve details of all reports
  • Retrieve details of a report using the report-id

The report details consist of the following fields:

Report detail fields
Field name Description
reportIdentifier Unique identifier of a report.
reportConfigurationId A system-generated unique identifier for a report configuration.
reportTypeNames The names of the report types.
reportStatus

Status of the report. Valid values are:

  • Requested — The report is scheduled and yet to be run.
  • Initiated — The report data is being generated.
  • Completed — The report completed successfully.
  • Errored — The report failed due to an error.
updateTimestamp Indicates the specific time of the day ( in hour, minute and second) when the configuration was most recently updated.
createTimestamp Designates the hour, minute, and second on a specific day when the record was created.
intervalParam

Interval parameter object. Contains two types of object structure:

  • Adhoc
  • Scheduled
intervalParam.scheduleFrequency (Adhoc & Scheduled) The planned intervals at which events, activities or processes occur. Allowed values: daily, weekly, monthly, and adhoc.
intervalParam.reportingPeriodStartTimestamp (Adhoc) Designates the hour (hh), minute (mm), seconds (ss) and date (if timestamp) or year (YYYY), month (MM), and day (DD) (if date) of the first occurrence of the reporting period.
intervalParam.reportingPeriodEndTimestamp (Adhoc) Designates the hour (hh), minute (mm), seconds (ss) and date (if timestamp) or year (YYYY), month (MM), and day (DD) (if date) of the last occurrence of the reporting period.
intervalParam.reportingPeriodStartTime (Scheduled) Designates the beginning hour, minute, and second boundary to which the report data pertains.
reportDetails Object that contains the details of the report.
reportDetails.reportFileName The merchant defined name for report file. By default=> "Entity ID". "Report Type" . "frequency". "From Date YYYY-MM-DD". "To Date YYYY-MM-DD"
reportDetails.url Reference to a web resource (/report-files/{report-id}) for retrieving the report data.
errorMessage Describes a message if problem occurred or error preventing the system from completing a task.
Note

You can retrieve the data in a report by using the request URL in the field reportDetails.URL. The URL contains a GET request to the /report-files/{report-id} endpoint, which returns the report data in the JSON reponse payload.

For more information, refer to how to retrieve report data.

Retrieve details of all reports

You can retrieve the details of all reports by sending a GET request to the /reports endpoint.

HTTP method: GET

Endpoint: /reports

Scenario: Retrieve the details of all reports.

Json
{
    "next": null,
    "summarizedReports": [
        {
            "reportIdentifier": "6ee97665-8d2c-424c-859a-dd98a9e4e0ca",
            "reportConfigurationId": "193544e3-0fdf-472e-8cae-798ff88da609",
            "reportTypeNames": [
                "Settlement Summary",
                "Settlement Details"
            ],
            "reportStatus": "requested",
            "updateTimestamp": "2021-08-23T00:23:05.353Z",
            "createTimestamp": "2021-08-23T00:19:05.353Z",
            "intervalParam": {
                "reportingPeriodStartTimestamp": "2021-08-23 00:18:18",
                "reportingPeriodEndTimestamp": "2021-08-23 00:19:18",
                "scheduleFrequency": "adhoc"
            }
        },
        {
            "reportIdentifier": "c6a6f075-64d5-476f-b463-bc1c5de1abd7",
            "reportConfigurationId": "ca788ad9-521c-45ec-b36d-0fdd38701e4d",
            "reportTypeNames": [
                "Transaction Details"
            ],
            "reportStatus": "completed",
            "updateTimestamp": "2021-08-20T00:23:05.353Z",
            "createTimestamp": "2021-08-20T00:19:05.353Z",
            "intervalParam": {
                "reportingPeriodStartTimestamp": "2021-08-20 00:18:18",
                "reportingPeriodEndTimestamp": "2021-08-20 00:19:18",
                "scheduleFrequency": "adhoc"
            },
            "reportDetails": {
                "reportFileName": "992994469896.Multiple.adhoc.2021-08-20.2021-08-20",
                "url": "https://sample-report-url"
            }
        }
    ],
    "lastPage": true
}
Tip

The GET /reports response uses pagination. Learn more about pagination. 

Retrieve details of a report

You can retrieve the details of a particular report by sending a GET request to the /reports/{report-d} endpoint.

HTTP method: GET

Endpoint: /reports/c6a6f075-64d5-476f-b463-bc1c5de1abd7

Scenario: Retrieve the details of the report with report-id = c6a6f075-64d5-476f-b463-bc1c5de1abd7

Json
{
    "reportIdentifier": "c6a6f075-64d5-476f-b463-bc1c5de1abd7",
    "reportConfigurationId": "ca788ad9-521c-45ec-b36d-0fdd38701e4d",
    "reportTypeNames": [
        "Settlement Summary",
        "Settlement Details"
    ],
    "reportStatus": "completed",
    "updateTimestamp": "2021-08-20T00:23:05.353Z",
    "createTimestamp": "2021-08-20T00:19:05.353Z",
    "intervalParam": {
        "reportingPeriodStartTimestamp": "2021-08-20 00:18:18",
        "reportingPeriodEndTimestamp": "2021-08-20 00:19:18",
        "scheduleFrequency": "adhoc"
    },
    "reportDetails": {
        "reportFileName": "992994469896.Multiple.adhoc.2021-08-20.2021-08-20",
        "url": "https://helix-data-reporting-files-int.uat.aws.jpmchase.net/api/v1/report-files/c6a6f075-64d5-476f-b463-bc1c5de1abd7"
    }
}