API Reporting Endpoint

Introduction

The reporting endpoint is used for the daily Reporting SQL Export.

Requirements for Using the Reporting Endpoint

To use this service you need the following:

1. API access for your system.
2. Enable the data exporter. This is achieved using the Reporting Data Exporter Setup page located under Admin -> Integrations.

NB: The Reporting SQL Export is only operational in our Production environment.

How the Reporting Endpoint Works

When you call the reporting endpoint Actionstep uses your security credentials to construct a unique URL for you to retrieve the reporting download file. This unique URL will be the response from calling the reporting endpoint. You then copy and paste this URL to another browser tab which will trigger the file download.

NB: The returned URL will be valid for 24 hours only.

Calling the Reporting API Endpoint

Before calling the reporting endpoint you need to authenticate to Actionstep in the normal manner (see Authentication for more information) You then make a GET request to the following endpoint:

GET {baseUrl}/reporting/reports

The response will be structured as follows:

{
    "dataExporterReportUrl" : "[url]"
}

[url] will be the unique URL for your specific file download and will be valid for 24 hours.

NB: The base URL for connecting to the Actionstep API typically looks something like:

https://ap-southeast-2.actionstep.com/api/rest/

But for this reporting endpoint please replace the "rest" component with "v2", i.e.

https://ap-southeast-2.actionstep.com/api/v2/reporting/reports

Matter Custom Field Data

Matter custom field data is made available in the ActionDataCollectionsFlattened table contained within the export file. This single table contains the custom field data values across all data fields for all matters and for all matter types within your database.

The ActionDataCollectionsFlattened table contains the following columns:

Column Name	Data Type
action_id	integer
action_type_id	integer
data_collection_id	integer
data_collection_name	string
data_collection_record_id	integer
data_field_name	string
data_type	string
string_value	string

For further information or assistance please contact our Global Support Team.