/v1/engagements/{tenant} Resource

Live Experience REST APIs. URI: /v1/*

GET /v1/engagements/{tenant}

Get the engagements for a specified tenant.

Request Parameters
name type description
Authorization header 'Bearer {access_token}' from /v1/auth request.
tenant path the tenant key (tenant name, such as PremierTenant).
endAfter query 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 query 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 query limit the number entries to return, default: 10, maximum: 100. To retrieve additional records, set the offset to a value above limit.
offset query start the query at the specified row number, default: 0. If set 'limit' must also be set.
sort query sort the results. Values: newest | oldest | shortest | longest. Default: newest. newest/oldest sort by start date, shortest/longest sort by duration.
startAfter query 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 query 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
user query email address of user to filter by. (can be specified multiple times)
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 OK
Content-Type: application/json

                
{
  "hasMore" : true,
  "engagements" : [ {
    "startDate" : 12345,
    "endDate" : 12345,
    "id" : "...",
    "duration" : 12345,
    "contents" : "...",
    "users" : [ {
      "uri" : "...",
      "association" : "..."
    }, {
      "uri" : "...",
      "association" : "..."
    } ],
    "recordings" : [ {
      "uri" : "...",
      "user" : "...",
      "created" : 12345,
      "duration" : 12345,
      "size" : 12345,
      "contents" : "..."
    }, {
      "uri" : "...",
      "user" : "...",
      "created" : 12345,
      "duration" : 12345,
      "size" : 12345,
      "contents" : "..."
    } ]
  }, {
    "startDate" : 12345,
    "endDate" : 12345,
    "id" : "...",
    "duration" : 12345,
    "contents" : "...",
    "users" : [ {
      "uri" : "...",
      "association" : "..."
    }, {
      "uri" : "...",
      "association" : "..."
    } ],
    "recordings" : [ {
      "uri" : "...",
      "user" : "...",
      "created" : 12345,
      "duration" : 12345,
      "size" : 12345,
      "contents" : "..."
    }, {
      "uri" : "...",
      "user" : "...",
      "created" : 12345,
      "duration" : 12345,
      "size" : 12345,
      "contents" : "..."
    } ]
  } ]
}