Reporting API

The Reporting API provides programmatic access to data reports generated by the system. The API supports retrieval of the following kinds of data reports:

  • Scheduled Reports
  • Daily Summary Reports
  • Transactional Level Reports (TLX)

Authentication

The API uses HTTP Basic Auth. The Username is your 6 digit client / customer ID. The Password is available via dashboard access. Navigate to "Company" > "Settings".

Endpoints

List Reports

API NameList Reports
OverviewReturns a list of available data reports to download
Resource Path/api/v3/reports/list
HTTP MethodGET
Response FormatJSON document
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.whiteops.com
Example Response
Status Code: 200 OK
Content-Type: application/json;charset=UTF-8

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

API NameGet Report
OverviewReturns a unique url for requested data report. Accessing the URL can then download the report.
Resource Path/api/v3/reports/get
HTTP MethodGET
Response FormatJSON document
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.whiteops.com
Example Response
Status Code: 200 OK
Content-Type: application/json;charset=UTF-8

{
    "data": {
        "url": "https://example.com/path",
        "expires": "2015-05-21T22:10:07.634Z"
    }
}