Get Report

GET https://{{axpAPIDomain}}/api/analytics/historical/v1/accounts/:accountId/reports/:reportName?pageSize=20&prevPageToken=<string>&nextPageToken=<string>&interval=<string>&filter=<string>

Gets the list of report data for a Report name.

Request Params

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 | | filter | string | | 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

RESPONSES

status: OK

{"columnHeaders":[{"name":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"records":[["\u003cstring\u003e","\u003cstring\u003e"],["\u003cstring\u003e","\u003cstring\u003e"]],"pagination":{"pageSize":"\u003cinteger\u003e","prevPageToken":"\u003cstring\u003e","nextPageToken":"\u003cstring\u003e"},"links":{"prev":"\u003cstring\u003e","next":"\u003cstring\u003e"}}