Using Reports

Note: For security purposes and to ensure data freshness, generated reports have a limited lifespan of one day. After one day has passed, they will no longer be valid or usable.

Highnote provides on-demand reports that empower you with data to drive your critical business decisions. This guide is provides on overview on using the Highnote GraphQL API to list and generate reports, check report statuses, and download reports.

You can generate up to three reports per day. The reportUsage allowance resets daily at 12 AM Eastern Standard Time (EST). Use the ReportUsage query to retrieve the following data:

• reportType: Displays the type of report
• limit: Displays your report usage limit; the default daily limit is three.
• limitRemaining: Displays how many reports are remaining from your usage limit; for example, if you have generated one report from your limit, this line would display 2 as your remaining limit
• periodEnd: The date and time when your usage limit resets

Use the following query to retrieve report usage data:

Note: You can generate up to three reports per day. The reportUsage allowance resets daily at 12 AM Eastern Time (ET).

You can generate a report using the InitiateReport mutation. When generating a report, you must provide the reportType, and all required or optional parameters. If required parameters are missing, a validation message is sent indicating which fields are missing.

Use the following mutation to generate a report:

Using a report ID, you can query the Report node to get report details for a single report. Important details to note include the download {url} and status:

To list all existing reports and their details, query the Reports object. You can filter the query by reportType and status to narrow down results if necessary.

Use the following query to list reports:

The Report Download Service (RDS) provides a secure and authenticated way to download reports. To use the RDS, you must provide your API key and the reportId that you received from either a notification or from using the ListReports API. With a reportId provided, RDS will provide a data stream of your report that you can use to download all report data.

The Report Download Service (RDS) supports a base64 encoded API key for authorization:

Request

Endpoint: /reports/{reportId}

Header

Body: N/A

Response

Header

Body: Stream of bytes

Response status: HTTP status codes returned in case of errors

Usage

The URL used to download reports differs whether you are using the test or live Environment.

The following example requests represent use cases for downloading reports using either a specific name or reportId in the live environment: