Note: Please make sure the read the overview before getting started with this method.

Description

Use this method to access the LivePerson monitoring system in order to report information regarding consumer activity within the brand's account. Such information can include engagement attributes or entry points. As engagement attributes are considered unauthenticated, it should not be used for business transactions that requires stronger authentication or information reliability.

Use cases

• Report on consumer engagement-attributes from any entry point within the App.

Request

Path Parameters

Query parameters

Body Parameters

^[1] At least one form of identification is required (consumerId / an identities.sub or vid).

Security considerations

• To avoid security problems and increase reliability, the consumerId or the sub key of the identities array (depending on which one you use) described in the table above must meet the following requirements:

  • Unguessable - using consumerID or a sub value which is based on any of the consumer's public information, such as name, email address, phone number, etc. can be guessed easily and is not recommended.

  • Innumerable - the consumerID cannot be comprised of serial numbers and must be a set of characters that have no structure, form, or scheme.

  • Unique per user - the consumerID cannot be recycled from one user to another. Do not reuse the same consumerID for more than one user, even if this user is not active anymore.

• A good consumerID would be:

  • UUID assigned specifically and uniquely for consumer

  • a hashed/salted email address

• For authenticated messaging flows: In order to support continuity and reporting, the consumerID must match the 'sub' claim reported inside the JWT. See Authentication → Implementation Guide for additional information on authentication.

PUT Request and body entity example

Example call URL

https://{liveperson-monitor-domain}/api/account/{account-id}/app/123/report?v=1.0&vid=myVisiorId&sid=mySessionId

Example Body Entity

{
 "consumerId":"myConsumerId",
 "identities": [
   {
        "iss": "LivePerson",
        "acr": "0",
        "sub": "identifierForNoAuth"
    },
    {
        "iss": "TMO",
        "acr": "loa1",
        "sub": "identifierForAuth"
    }
 ],
 "pageId": "4743822558",
 "entryPoints":[
   "tel://972737004000",
   "https://www.brand.com",
   "sec://Sport",
   "lang://English"
 ],
 "engagementAttributes": [
   {
       "type": "purchase",
       "total": 11.7,
       "orderId": "DRV1534XC"
	},
	{
       "type": "lead",
           "lead": {
           "topic": "luxury car test drive 2015",
           "value": 22.22,
           "leadId": "xyz123"
       }
   }
 ]
}

Examples for engagement attributes to report impression events

ImpressionAcceptEvent:

Note: This impression is counted under the ACCEPTED OFFERS metric in LivePerson's Analytics Builder. For more information on the Analytics Builder and its metrics, please refer to this document.

{
  "type": "impAccept",
  "campaign": 3115242510,
  "engId": 3115242810,
  "revision": 537,
  "eContext": [
    {
      "type": "engagementContext",
      "id": "1"
    }
  ]
}

ImpressionDisplayEvent:

Note: This impression is counted under the EXPOSURES, EXPOSED and ENGAGEMENT VIEWS metric in LivePerson's Analytics Builder. For more information on the Analytics Builder and its metrics, please refer to this document.

{
  "type": "impDisplay",
  "campaign": 3115242510,
  "engId": 3115242810,
  "revision": 537,
  "eContext": [
    {
      "type": "engagementContext",
      "id": "1"
    }
  ]
}

ImpressionExpandedEvent:

{
  "type": "impExpanded",
  "expanded": null,
  "userInit": null,
  "actionableItems": null,
  "campaign": 3115242510,
  "engId": 3115242810,
  "revision": 537
}

ImpressionTimeoutEvent:

{
  "type": "impTimeout",
  "campaign": 3115242510,
  "engId": 3115242810,
  "revision": 537
}

ImpressionCloseEvent:

{
  "type": "impClose",
  "campaign": 3115242510,
  "engId": 3115242810,
  "revision": 537
}

Response

Response entity examples

Status code: 200 OK — Operation performed successfully:

{
  "sessionId": "abc",
  "visitorId": "xyz",
  "pageId": "4743822558"
}

Status code: 400 Bad request — Operation failed:

{
  "time":1513095142268,
  "message":"consumerId",
  "internalCode":5
}

Loading Account: API version 1.0, Status code 500 Server Error -

{
    "time":1501074704502,
    "message":"Loading account: ta3hWd4IgG, vid: myVisitorId",
    "internalCode":20
}

API version 1.1, Status code 202 Accepted -

{
    "time":1501074704502,
    "message":"Loading account: ta3hWd4IgG, vid: myVisitorId",
    "internalCode":38
}

Response Format

Response Codes

Retry Policy Recommendation

Specifically in the case of a "Loading account" response (500 in API version 1.0, 202 in API version 1.1), it is important to retrieve the value of the vid from the response body and append it as the value of the vid query param for the retry request (to be issued following a pause interval of a few seconds).

Limitations