Reporting API
HUMAN's Reporting API lets you fetch reports that contain your HUMAN data. These reports are generated as .csv files.
For more information about how to use these endpoints, consult How to Use the Reporting API.
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 Reporting API, please reach out to a HUMAN representative.
The Reporting API includes two endpoints: one to return a list of reports, and one to fetch a download link for a specified report.
List available reports
Returns a list of reports available for download.
query Parameters
| type | string Lets you filter the API response list by report type. Possible values are |
Responses
Response samples
- 200
[- {
- "data": [
- {
- "type": "export",
- "name": "testExport.csv",
- "createdAt": "2015-05-01T20:00:00.000Z",
- "fileSize": "264b"
}, - {
- "type": "report",
- "name": "testReport.csv",
- "createdAt": "2015-05-01T20:00:00.000Z",
- "fileSize": "1.81kb"
}
]
}
]Fetch report URL
Returns the URL of your requested report. You can then download the report file from its unique URL.
query Parameters
| name required | string The name of the report you'd like to access. You can find a list of possible values from the List Reports response. This value should be URL encoded. |
| type required | string The type of report to access. Possible values are |
Responses
Response samples
- 200
[
]