/v1/engagements/{tenant} Resource

Live Experience REST APIs. URI: /v1/*

GET /v1/engagements/{tenant}

Get the engagements for a specified tenant. Following parameters are accepted:

status
Use this filter to differentiate between successful and unsuccessful engagement. By default, successful engagements are returned.
To return only successful engagements, set status to successful or leave it blank.

user
email address of user to filter by. (can be specified multiple times).

startAfter
earliest start date to filter by. iso-date, format: yyyy-mm-ddThh:mi:ss, For example: 2018-01-15T10:25:11 or 2018-01-10.

startBefore
latest start date to filter by. iso-date, format: yyyy-mm-ddThh:mi:ss, For example: 2018-01-15T10:25:11 or 2018-01-10.

endAfter
earliest end date to filter by. iso-date, format: yyyy-mm-ddThh:mi:ss, For example: 2018-01-15T10:25:11 or 2018-01-10.

endBefore
latest end date to filter by. iso-date, format: yyyy-mm-ddThh:mi:ss, For example: 2018-01-15T10:25:11 or 2018-01-10.

limit
limit the number entries to return, default: 10, maximum: 100. To retrieve additional records, set the offset to a value above limit.

offset
start the query at the specified row number, default: 0. If set 'limit' must also be set

sort
sort the results. Values: newest | oldest | shortest | longest. Default: newest. newest/oldest sort by start date, shortest/longest sort by duration.

Request Parameters
name type description constraints
Authorization header 'Bearer {access_token}' from /v1/auth request.  
tenant path the tenant key (tenant name, such as PremierTenant). required
Response Body
media type data type description
application/json EngagementListV1 (JSON) a list of engagements for the tenant that match the query parameters.
application/xml engagementListV1 (XML)
text/xml engagementListV1 (XML)

Example

Request
GET /v1/engagements/{tenant}
Accept: application/json
Authorization: ...
Response
HTTP/1.1 200 Looks Good
Content-Type: application/json

                
{
  "hasMore" : true,
  "engagements" : [ {
    "startDate" : "...",
    "endDate" : "...",
    "id" : "...",
    "duration" : 12345,
    "contents" : "...",
    "context" : "...",
    "users" : [ {
      "uri" : "...",
      "association" : "..."
    }, {
      "uri" : "...",
      "association" : "..."
    } ],
    "recordings" : [ {
      "uri" : "...",
      "user" : "...",
      "created" : "...",
      "duration" : 12345,
      "size" : 12345,
      "contents" : "..."
    }, {
      "uri" : "...",
      "user" : "...",
      "created" : "...",
      "duration" : 12345,
      "size" : 12345,
      "contents" : "..."
    } ],
    "releaseState" : "...",
    "status" : "...",
    "pendingTime" : 12345,
    "assignedTeam" : "...",
    "associateInitiated" : true,
    "reason" : "..."
  }, {
    "startDate" : "...",
    "endDate" : "...",
    "id" : "...",
    "duration" : 12345,
    "contents" : "...",
    "context" : "...",
    "users" : [ {
      "uri" : "...",
      "association" : "..."
    }, {
      "uri" : "...",
      "association" : "..."
    } ],
    "recordings" : [ {
      "uri" : "...",
      "user" : "...",
      "created" : "...",
      "duration" : 12345,
      "size" : 12345,
      "contents" : "..."
    }, {
      "uri" : "...",
      "user" : "...",
      "created" : "...",
      "duration" : 12345,
      "size" : 12345,
      "contents" : "..."
    } ],
    "releaseState" : "...",
    "status" : "...",
    "pendingTime" : 12345,
    "assignedTeam" : "...",
    "associateInitiated" : true,
    "reason" : "..."
  } ]
}