gainsight-px-rest-api
GET /v1/admin/monitoring/engagement_collisions

Retrieves engagement collision events. Will return one row for each engagement collision in the given date range. Supports filtering and paging.

Filtering

The date range must be less than or equal to 180 days Dates are specified as epoch milliseconds, GMT Examples:

URI Results
GET /v1/admin/monitoring/engagement_collisions?dateRangeStart=1670283822000&dateRangeEnd=1672962222000&propertyKey=AP-XXXXXXXXXXX-2 Fetches first page of results
GET /v1/admin/monitoring/engagement_collisions?dateRangeStart=1670283822000&dateRangeEnd=1672962222000&propertyKey=AP-XXXXXXXXXXX-2&pageNumber=1&scrollId=abcxyz Fetches second page of results

Query parameters

  • dateRangeEnd integer(int64)

    Date range end (epoch milliseconds)

  • dateRangeStart integer(int64)

    Date range start (epoch milliseconds)

  • pageNumber integer(int32)

    Page Number (zero based)

    Default value is 0.

  • pageSize integer(int64)

    Number of records per page

    Minimum value is 1, maximum value is 1000. Default value is 25.

  • propertyKey string

    Product Key

  • scrollId string

    Used for fetching subsequent pages after the first one. Returned in response.scrollId. If null, no additional pages are available

Responses

  • 200 */*

    Success

    Hide response attributes Show response attributes object
    • engagementCollisions array[object]

      Array of engagement collisions

      Hide engagementCollisions attributes Show engagementCollisions attributes object

      Engagement Error Summary

      • engagementId string
      • engagementName string
      • propertyKey string

        PX Product Tag Key

      • engagementType string

        Values are EMAIL, IN_APP_DIALOG, IN_APP_CAROUSEL, IN_APP_GUIDE, IN_APP_NOTIFICATION, OUT_BOUND_EMAIL, IN_APP_NPS_SURVEY, IN_APP_CES_SURVEY, IN_APP_RATING_SURVEY, IN_APP_BOOLEAN_SURVEY, or IN_APP_MULTIPLE_QUESTION_SURVEY.

      • otherQualifiedEngagementNames array[string]

        Names of other qualified engagements

      • views integer(int64)

        Number of views

      • priorityRule string

        Priority rule

      • triggeredDate integer(int64)

        Timestamp of collision, in epoch milliseconds

      • viewedByUser string

        User id

    • totalHits integer(int64)

      Total number of records matching filters

    • scrollId string

      If passed on subsequent requests as the scrollId parameter, will fetch the next page
  • 400

    Bad request

  • 401

    Unauthorized or bad API Key

  • 429

    Rate limit exceeded

GET /v1/admin/monitoring/engagement_collisions 
curl \
 --request GET 'https://api.aptrinsic.com/v1/admin/monitoring/engagement_collisions'
Response examples (200) 
{
  "engagementCollisions": [
    {
      "engagementId": "string",
      "engagementName": "string",
      "propertyKey": [
        "AP-XXXXXXXXXX-2"
      ],
      "engagementType": "EMAIL",
      "otherQualifiedEngagementNames": [
        "string"
      ],
      "views": 42,
      "priorityRule": "string",
      "triggeredDate": 42,
      "viewedByUser": "string"
    }
  ],
  "totalHits": 42,
  "scrollId": "string"
}