Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Search events

get/events/search

Query parameters

eventIdstring
eventNamestring
userIdentifierType'mobile' | 'email' | 'userId'
userIdentifierValuestring
userIdentifierSourcestring
userIdentifierAccountIdstring
userGroupIdentifierType'groupId' | 'groupExternalId' | 'mobile' | 'email' | 'userId'
userGroupIdentifierValuestring
userGroupIdentifierSourcestring
userGroupIdentifierAccountIdstring
fromDatestring
tillDatestring
limitstring
offsetstring
sortOrder'ASC' | 'DESC'
includeSideEffectsboolean

Pass true to include side effects of the event in the response. The sideEffects.awardedPoints value reflects the points awarded when the event was originally processed and is not updated by subsequent manual ledger adjustments. To see the customer's current point balance, use the Get Customer Ledger Balance API.

isDuplicateboolean

true, false

Response

200

OR
OR
OR

Example response

{
  "clickEventDataList": [
    {
      "orgId": 100458,
      "userId": 555734097,
      "date": "2024-05-16T19:15:28Z",
      "eventName": "be_reserved",
      "eventId": "62336aee-0a80-4606-a19e-c2879e2cd9e5",
      "source": "INSTORE",
      "displayName": "be_reserved",
      "additonalAttributes": {
        "age": "20.0",
        "autoUpdateTimeStamp": 1715886928261,
        "customerId": "555734097",
        "displayName": "be_reserved",
        "eventDateTime": "1715886927000",
        "eventName": "be_reserved",
        "external_event_id": "RAND118",
        "hotel_name": "Indiranagar",
        "orgId": 100458,
        "room_nights": "12",
        "source": "INSTORE",
        "source_user_id": 555734097
      },
      "psiAttributes": [
        "age"
      ]
    }
  ],
  "totalRecords": 9
}