Interaction Message Details from Reporting API

Interaction - The end-to-end communications with a particular agent and user through a particular channel. This call can be used to follow an interaction through its complete lifecycle.
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.
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.
Time 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:

200
401
403

Example return:

{
  "resultCode": 0,
  "resultCodeName": "Success",
  "data": [
    {
      "_id": "04806c03-c5b2-4ec9-9b65-4a13bf25d375",
      "TenantId": 2,
      "Type": 1,
      "EventType": 24,
      "EventTypeReason": 3,
      "AgentMessage": {
        "State": {
          "SessionId": "e1fe5816-358a-4a62-901b-8904af59a115",
          "AgentId": 10614,
          "FirstName": "Agent First Name",
          "LastName": "Agent Last Name",
          "LoggedIn": true,
          "RoutingProfileId": 6,
          "TenantId": 2,
          "ChannelState": {
            "StateId": 1,
            "UpdatedAt": [
              637873608547722600,
              0
            ],
            "TrackedAs": 0,
            "SubState": 0,
            "PendingStateId": 0,
            "PreviousStateId": 2,
            "PreviousTrackedAs": 1,
            "PreviousStateDuration": 2064
          },
          "PreviousChannelState": {
            "StateId": 2,
            "UpdatedAt": [
              637873608547722600,
              0
            ],
            "TrackedAs": 1,
            "SubState": 0,
            "PendingStateId": 0,
            "PreviousStateId": 2,
            "PreviousTrackedAs": 1,
            "PreviousStateDuration": 2064
          },
          "PreviousChannelStateDuration": 2064,
          "ChannelProviderId": 0,
          "QueueList": null
        }
      },
      "WorkItemMessage": {
        "WorkItem": null,
        "QueueWaitingCount": 0
      },
      "InteractionId": null,
      "Date": [
        637873608548481800,
        0
      ],
      "DateUtc": "2022-05-05T15:20:54.848Z"
    }
  ],
  "dataType": "JObject",
  "paging": {
    "total": 132464,
    "limit": 1,
    "offset": 0
  },
  "hasPaging": true
}