Skip to navigation
Reporting API

About the Reporting API

HUMAN’s Reporting API lets you download report files that contain your HUMAN data. These are the same reports that you configure and access through the HUMAN Dashboard.

You can use the Reporting API to fetch the following kinds of reports:

The Reporting API lets you download report files that have already been generated, but you can’t use the Reporting API to create new reports directly.

Authentication

The Reporting API uses Basic Auth to authenticate requests. You’ll need to use the following values as your username and password:

  • Username: The unique six-digit Customer ID associated with your HUMAN account.
  • Password: The Reporting API key associated with your HUMAN account. You can find this value in the Integrations > Reporting section of the HUMAN Dashboard.

If you’re unable to access these values or need help authenticating your calls to the Reporting API, contact your HUMAN representative.

Create reports via the HUMAN Dashboard

Before you can use the Reporting API to download reports, you’ll need to create or schedule a report via the HUMAN Dashboard.

If you create a report that runs on a recurring schedule, each file generated by that report will be available through the Reporting API. For example, if a report is scheduled to run once a week, you can download the latest weekly report whenever it’s ready (as well as earlier versions of that report from previous weeks).

A scheduled TLX report can produce several files per run, each with its own file name. For reports that use the new file name, the /get response includes the object path for each file.

Download report files via the Reporting API

After you’ve created reports, you can download any available report files through the Reporting API. This process involves three steps:

  1. Use the /list endpoint to return a list of reports available for download.
  2. From this list of reports, find the name of the report you’d like to download, then include this name as a query parameter in a request to the /get endpoint. For TLX reports with several files per run, request each file separately.
  3. The /get endpoint returns a URL. Visit this URL to download your report file.