Skip to content

Get Interactions of an Agent

Description

Retrieves detailed conversation records for a specific agent (userId) within a given time interval.

Business Application

Used for Deep-Dive Analysis and auditing. Supervisors use this to review specific interactions for coaching opportunities or dispute resolution.

Endpoint

POST https://api.mypurecloud.de/api/v2/analytics/conversations/details/query

Request

Headers

  • Authorization: Bearer Token
  • Content-Type: application/json

Body Parameters

Name Type Mandatory Description
interval DateTime Yes Time range for this query. Dynamic: Calculate based on current date (e.g., Last 7 Days).
order Enum Yes Asc/desc depending on the order of items requested
orderBy String Yes Field to order by (e.g. conversationStart)
paging Object Yes Pagination settings (pageSize, pageNumber)
segmentFilters Array Yes Array of predicates. Use userId retrieved from Get All Users.

Sample Request

{
  "interval": "2025-11-10T00:00:00.000Z/2025-11-17T23:59:59.999Z",
  "order": "asc",
  "orderBy": "conversationStart",
  "paging": {
    "pageSize": 100,
    "pageNumber": 1
  },
  "segmentFilters": [
    {
      "type": "and",
      "predicates": [
        {
          "type": "dimension",
          "dimension": "purpose",
          "operator": "matches",
          "value": "agent"
        },
        {
          "type": "dimension",
          "dimension": "userId", 
          "value": "<USER_ID>" 
        }
      ]
    }
  ]
}

CURL Example

curl -X POST 'https://api.mypurecloud.de/api/v2/analytics/conversations/details/query' \
  -H 'Authorization: Bearer *******************' \
  -H 'Content-Type: application/json' \
  --data-raw $'{"interval":"2025-11-10T00:00:00.000Z/2025-11-17T23:59:59.999Z","order":"asc","orderBy":"conversationStart","paging":{"pageSize":100,"pageNumber":1},"segmentFilters":[{"type":"and","predicates":[{"type":"dimension","dimension":"purpose","operator":"matches","value":"agent"},{"type":"dimension","dimension":"userId","value":"<USER_ID>"}]}]}'

Response

Body Parameters

Name Type Description
conversations Array Array of results in conversations
totalHits Number Number of conversations

Sample Response

{
    "conversations": [],
    "totalHits": 21
}