Generating Reports via API

ACE Remote API access allows external applications to generate SQL reports from ACE using API requests.

This article explains how to:

• Generate a Remote API key

• Retrieve a report using the API

• Generate a report with and without filters

• Pass report filters using JSON parameters

Note

A SQL report must already exist before using this procedure. A basic understanding of JSON is also recommended when working with report parameters.

Before You Begin

The following concepts and components are required to generate reports through the ACE API. These values are used for both standard and filtered report requests.

Understanding the Components

Before generating reports via API, it is helpful to understand the components used in the request.

Generating  API Key for Remote API Access

Generate a Remote API access key from the user profile.

1. Open the user profile.

2. Generate the Remote API key.

3. Save the user record after generating the key.

4. Copy the generated API key for use in API requests.

For enhanced security, regenerate the API key periodically based on your organization's security policies.

For additional information, view Generate API Key for User.

Retrieve the Report Identifier

1. Go to Reports → SQL Designer.

2. Open the SQL Report

3. Copy the Report Identifier from the field.

Generate a Report Without Filters

The following example demonstrates how to generate a report using only the required URL parameters without applying report filters.

1. Go to Help → API Documentation.

2. Navigate to the Reports section.

3. Click "Post" and then click "Try it out".

4. Fill in the required information:

   1. customerID*

   2. identifier* (Report Identifier) 

   3. type* (Custom,Inventory )

   4. generate* (true)

5. Click "Execute" and copy the requested URL.

6. Open new web browser, paste the URL to view the report.

Example Report URL:

https://test.interprose.com/report/runner.do?customerID=GINA&identifier=VIEWED_ACCOUNTS&type=CUSTOM&generate=true&apiKey=YOUR_API_KEY

Generate a Report With Filters

Report filters can be added to the request using the params URL parameter with JSON-formatted values. The following example builds on the previous request by filtering report results using a date range.

Step 1: Identify the Report Parameters

Determine the parameter names used in the SQL report.

Example parameter:

[
  {
    "name": "createDate",
    "valueStart": "01/01/2023",
    "valueEnd": "07/01/2023"
  }
]

Step 2: Encode the JSON Parameters

Use a URL encoding tool such as: https://www.urlencoder.org/

1. Paste the JSON parameter into the encoder

2. Click Encode

3. Copy the encoded parameter value

Encoded Parameters Example:

%5B%0A%20%20%7B%0A%20%20%20%20%22name%22%3A%20%22createDate%22%2C%0A%20%20%20%20%22valueStart%22%3A%20%2201%2F01%2F2023%22%2C%0A%20%20%20%20%22valueEnd%22%3A%20%2207%2F01%2F2023%22%0A%20%20%7D%0A%5D

Step 3: Append the Encoded Parameters to the URL

Add the encoded JSON using: &params= 

Final URL Example with Parameters

https://test.interprose.com/report/runner.do?customerID=GINA&identifier=VIEWED_ACCOUNTS&type=CUSTOM&generate=true&apiKey=YOUR_API_KEY&params=%5B%7B%22name%22%3A%22createDate%22%2C%22valueStart%22%3A%2201%2F01%2F2023%22%2C%22valueEnd%22%3A%2207%2F01%2F2023%22%7D%5D

API Request Parameter Reference

Ensure that the parameter names, URL string values, and variables are correctly provided:

Params Example:

&params=[{"name":"agencyNumber","value":"123456721"}]

Security and Permissions

The API request runs using the permissions of the user associated with the API key.

Keep the API key secure and avoid exposing it in unsecured locations or shared documentation.