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

The unique name of the report

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

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

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.
• interval=YYYYMMDDHHmm
  • YYYYMMDDHH00 corresponds to >= 00 mins and < 15 mins interval
  • YYYYMMDDHH15 corresponds to >= 15 mins and < 30 mins interval
  • YYYYMMDDHH30 corresponds to >= 30 mins and < 45 mins interval
  • YYYYMMDDHH45 corresponds to >= 45 mins and < 00 mins interval
• interval=starting:YYYYMMDDHHmm
  • corresponds to >= YYYYMMDDHHmm
• interval=ending:YYYYMMDDHHmm
  • corresponds to < YYYYMMDDHHmm
• interval=starting:YYYYMMDDHHmm,ending:YYYYMMDDHHmm
  • starting:YYYYMMDDHH00,ending:YYYYMMDDHH30 corresponds to >= 00 mins and < 30 mins
  • starting:YYYYMMDDHH30,ending:YYYYMMDDHH30 doesn't return data
• Example values:
  • 202012010400
  • starting:202012010415
  • ending:202012251530
  • starting:202012010415,ending:202012251545

For EngagementDetail report

• Every engagement is mapped to a 15 min interval according to its start time. For example, if engagement start time is 2024-08-15 06:23:10.422+00 it will be reflected in the interval 202408150615
• 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.
• interval=YYYYMMDDHHmm
  • YYYYMMDDHH00 corresponds to >= 00 mins and < 15 mins interval
  • YYYYMMDDHH15 corresponds to >= 15 mins and < 30 mins interval
  • YYYYMMDDHH30 corresponds to >= 30 mins and < 45 mins interval
  • YYYYMMDDHH45 corresponds to >= 45 mins and < 00 mins interval
• interval=starting:YYYYMMDDHHmm
  • corresponds to >= YYYYMMDDHHmm
• interval=ending:YYYYMMDDHHmm
  • corresponds to < YYYYMMDDHHmm
• interval=starting:YYYYMMDDHHmm,ending:YYYYMMDDHHmm
  • ending interval is included in the report
    • starting:YYYYMMDDHH00,ending:YYYYMMDDHH30 corresponds to >= 00 mins and < 45 mins
    • starting:YYYYMMDDHH30,ending:YYYYMMDDHH30 corresponds to >= 30 mins and < 45 mins
• Example values:
  • 202012010400
  • starting:202012010415
  • ending:202012251530
  • starting:202012010415,ending:202012251545

For AgentLoginLogout report

• All datetime expressions for login/logout report should use the format YYYYMMDD or YYYYMMDDHHmm
• interval=starting:YYYYMMDDHHmm
  • corresponds to >= YYYYMMDDHHmm
• interval=starting:YYYYMMDD
  • corresponds to >= YYYYMMDD0000
• interval=ending:YYYYMMDDHHmm
  • corresponds to < YYYYMMDDHHmm
• interval=ending:YYYYMMDD
  • corresponds to < YYYYMMDD0000
• interval=starting:YYYYMMDDHHmm,ending:YYYYMMDDHHmm
  • starting:YYYYMMDDHH00,ending:YYYYMMDDHH30 corresponds to >= 00 mins and < 30 mins
  • starting:YYYYMMDDHH12,ending:YYYYMMDDHH25 corresponds to >= 12 mins and < 25 mins
  • starting:YYYYMMDDHH30,ending:YYYYMMDDHH30 doesn't return data
• interval=starting:YYYYMMDD,ending:YYYYMMDD
  • corresponds to >= YYYYMMDD0000 (starting) and < YYYYMMDD0000 (ending)
• Example values:
  • starting:20201201
  • starting:202012010417
  • ending:20201225
  • ending:202012251533
  • starting:20201201,ending:20201225
  • starting:202012010417,ending:202012251533

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

Generated from available response content types