Risk Cloud API: Export Table Report

Updated on: February 01, 2024

Exporting Table Report data via the Risk Cloud API in a CSV or XLSX is a common use case, as it provides a means of exporting record data in the same format as it would be displayed within a table report in the Risk Cloud web application.

In this article, we will walk through the steps necessary for obtaining a table report, and its records, as a CSV or XLSX data export via the Risk Cloud API.

  1. Obtain the table-report-id that you would like applied as the columns for the CSV or XLSX export
  2. Retrieve Table Report Export
POST/api/v1/records/export/csv

Authentication

Obtain your API Access Token to get started, and for more on exporting record data and exporting table reports, refer to our Help Center articles Export Record Data and Export Data from Table Reports.

Step 1: Obtain the table-report-id

The table-report-id can be obtained from the Risk Cloud web application or via the Risk Cloud API. If you already know your table-report-id you may continue to Step 2: Retrieve Table Report Export

Using the Risk Cloud application

The most straightforward way to find the table report ID for table-report-id is to open the desired table report from the reporting page located at Reports > Table Reports in the Risk Cloud web application, then take the ID from the end of the URL.

https://your-company.logicgate.com/report/tableReport/{table-report-id}

Using the Risk Cloud API

The Retrieve Table Reports endpoint returns all table reports that the user is entitled to by workflow. If no table reports are returned, check the permissions of the requesting API user to ensure that proper permissions are granted.

GET/api/v1/internal/tableReports

This endpoint has the following optional query parameters for additional filtering.

Query Parameter Description
applicationId The unique ID of an application where, if provided, the response will only contain table reports from the identified application.
query A query string where, if provided, the response will be filtered to only contain table reports that have a title, application name, or workflow name that have a case-insensitive match with the given query string
page The zero-indexed page number (must not be less than 0, defaults to 0).
size The size of the page and maximum number of items to be returned (must not be less than 1, defaults to 20).
Response Body

This will return a paginated response of table report objects, each looking like the following. For more information on iterating paginated responses, reference the article Risk Cloud API: Pagination. Parse the table report objects by properties like workflowName, applicationName, or title until you have located the intended table report.

{
  "id": "a1b2c3d4",
  "title": "My Table Report",
  "created": 1685482001992,
  "updated": 1685482002192,
  "modified": 1685482002192,
  "defaultLayout": false,
  "workflowId": "e5f6g7h8",
  "workflowName": "My Workflow",
  "applicationId": "i9j0k1l2",
  "applicationName": "My Application",
  "applicationLive": true,
  "applicationPermissionsEnabled": false,
  "applicationColor": "#49b800",
  "applicationIcon": "fas__fa-cubes",
  "totalLayoutFields": 2,
  "homeScreenPresent": false,
  "creatorEmail": "[email protected]",
  "creatorName": "Jane Doe",
  "totalReportFilters": 0,
  "totalJoins": 0
}

2. Retrieve Table Report Export

In this step, we will use the table-report-id found in the previous step to export the table report, and its record data, as a CSV or XLSX. The csv in the path may be swapped for xlsx to switch the returned format of the spreadsheet.

POST/api/v1/records/export/csv
Sample Request Body
{ 
  "tableReport": "table-report-id"
}
Response

A CSV or XLSX of the table report record data, with field columns reflecting the table report.