These docs are for v0.0.1. Click to read the latest docs for v1.0.63.

Get Report

Gets the list of report data for a Report name.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 6 and 6
^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

string
required
length between 1 and 50

The unique name of the report

Query Params
int32
1 to 150
Defaults to 20

The maximum number of results per page.

string
length between 36 and 36

The page token of the previous set of records to retrieve, represented as unique 36 characters(uuid).

string
length between 36 and 36

The page token of the next set of records to retrieve, represented as unique 36 characters(uuid).

string
length between 8 and 41

Specify the interval range to be used.
Must contain either a single datetime value or both 'starting' and 'ending' datetimes. The datetime format is dependent on the type of report selected which can derived from the 'reportName'.

For daily reports (reportName always ends with 'Daily' for example 'AgentDaily')

  • datetime implies specific day(s).
  • all datetime expressions should use YYYYMMDD format.
  • 'HHmm' values should be either omitted or replaced with 0000 – The API will return an error when other 'HHmm' values are specified.
  • Example values:
    • 20201201
    • starting:20201201
    • ending:20201225
    • starting:20201201,ending:20201225

For interval reports (reportName always ends with 'Interval' for example 'AgentInterval')

  • all datetime expressions should use YYYYMMDDHHmm format.
    'mm' part can be used to indicate the 15 min interval such as '00', '15', '30' or '45' - The API will return an error when other 'mm' values are specified.
    • 00 corresponds to >= 00 mins and < 15 mins interval
    • 15 corresponds to >= 15 mins and < 30 mins interval
    • 30 corresponds to >= 30 mins and < 45 mins interval
    • 45 corresponds to >= 45 mins and < 00 mins interval
  • Example values:
    • 202012010400
    • starting:202012010415
    • ending:202012251530
    • starting:202012010415,ending:202012251545
string
length between 3 and 256

Specifies details of a row filter. The allowed format:

  • Begins with the column name to be filtered, followed by a colon, then:
  • Either an exact string to match, or
  • A string expression including the * wildcard character
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json