Agent Workstate Details from Reporting API

Workstate - the user's current state and what activities the user can currently engage in. The current state an agent is in. Agents in the available state can receive interactions.
- Workstates other than available can be created to allow tracking of agent time.
Authentication required, please visit this page for Authentication How To.

Parameters

Fields - See Reporting API Field Definitions
OrderBy - Any string in the result can be used to order the results.
Filter If left blank all values are returned. If fields added only chosen fields will be returned.
- For more information on Filters see: Reporting Filters
Limit - Limits the number of search results.
Offset - This value goes along with Limit. The offset is where the limit starts.
- Ex. A user wants 10 results, but doesn't want the first 15 displayed. A Limit of "10" and an Offset of "15" would give results 16 through 25.
StartDateTime - When to start pulling data from API.
EndDateTime - When to stop pulling data from API.
RelativePeriodStart - To start query one of multiple days in the future, 1,2, etc. or to do in past -1, -2, etc.
RelativePeriodEnd - To end query one of multiple days in the future, 1,2, etc. or to do in past -1, -2, etc.
RelativeTime Zones For API information about Times Zone, please visit this page on Time Zones.
- When left blank the default is UTC.
- Date ranges can be in ISO format.
- For more information on Date Ranges see: Reporting Date Range Handling
Resolution - Size periods of the request. Can be by quarter hour, 1 hour, or 1 day.
It is recommended advanced filter object be done outside of the API document for best results.

Responses available:

Example return:

{
  "resultCode": 0,
  "resultCodeName": "Success",
  "data": [
    {
      "_id": "6273eb5869de5c8ebface97e",
      "AgentId": 10614,
      "EventType": 24,
      "Epoch": 1651764056,
      "EpochDate": 1651764056,
      "EpochQuarterHour": 1651763700,
      "EpochHour": 1651762800,
      "FirstName": "Agent First Name",
      "LastName": "Agent Last Name",
      "LoggedIn": true,
      "RoutingProfileId": 6,
      "TenantId": 2,
      "CurrentChannelStateId": 1,
      "CurrentChannelStateTrackedAs": 0,
      "PreviousChannelStateId": 2,
      "PreviousChannelStateTrackedAs": 1,
      "SubState": 0,
      "PendingStateId": 0,
      "PreviousChannelStateDuration": 2064,
      "ChannelProviderId": 0,
      "QueueList": null,
      "EventAtUtc": "2022-05-05T15:20:56.117Z"
    }
  ],
  "dataType": "JObject",
  "paging": {
    "total": 43919,
    "limit": 1,
    "offset": 0
  },
  "hasPaging": true
}