Reporting API Endpoints

HUMAN's Reporting API includes the following endpoints:

List Reports

Returns a list of downloadable reports.

Resource path: /api/v3/reports/list

HTTP method: GET

Request format: JSON document

Response format: JSON document

Authentication: See our Authentication guide.

Parameters

type: (Optional) Lets you filter the API response list by report type. Possible values are "report" and "export".

Example Request

GET /api/v3/reports/list
Host: dashboard.humansecurity.com

Example Response

Status Code: 200 OK

Content-Type: application/json;charset=UTF-8
Date: Wed, 22 Oct 2014 21:13:46 GMT
{
"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"
}
]
}

Get Report

Returns the URL of your requested report. You can then access this URL to download the report.

Resource path: /api/v3/reports/get

HTTP method: GET

Request format: JSON document

Response format: JSON document

Authentication: See our Authentication guide.

Parameters

name: (Required) 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) The type of report to access. Possible values are "report" and "export".

Example Request

GET /api/v3/reports/get?type=report&name=testReport.csv
Host: dashboard.humansecurity.com

Example Response

Status Code: 200 OK
Date: Wed, 22 Oct 2014 21:13:46 GMT
{
"data": {
"url": "https://testurl.com",
"expires": "2015-05-21T22:10:07.634Z"
}
}