API Endpoints

API Name: List Reports
Overview: Returns a list of available data reports to download
Resource Path: /api/v3/reports/list
HTTP Method: JSON document
Response Format: JSON document
Authentication: see Authentication.
Parameters: Name: type
Required: false
Description: Used to filter API response list. Options are currently
only “report” or “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"
}
]
}

 

API Name: Get Report
Overview:

Returns a unique url for requested data report. Accessing the URL can then download the report.

Resource Path: /api/v3/reports/get
HTTP Method: GET
Request Format: JSON document
Response Format: JSON document
Authentication: see Authentication.
Parameters:

Name: type
Required: true
Description: Type of report to access. Value is retrieved from
response of the list report API. Options are currently only “export” or
“report”


Name: name
Required: true
Description: Name of resource to generate URL for. Value is
retrieved from response of the list report API. Value should be URL
encoded.

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"
}
}