Engagement Custom Event API

Last updated
Save as PDF

Overview

Gainsight PX Engagement Custom Event API allows you to return a list of custom events that are specified as triggers in the audience rules for active engagements.

Custom events include the following:

Events referenced directly in the audience rules
Events referenced indirectly via a mapped feature

By using this API, the custom events sent to Gainsight PX can be limited to those that are associated with active engagements.

API Endpoint

GET https://esp.aptrinsic.com/rte/v1/engagement/rules?p={productId}&t=CUSTOM_EVENTS

Example:

https://esp.aptrinsic.com/rte/v1/engagement/rules?p=AP-XXXXXXXXXXXX-2&t=CUSTOM_EVENTS

Syntax

The syntax of the API is:

{
  "customEvents": [
    {
      "name": "", // custom event name
      "properties": [] // Array of event property names
    }
  ]
}

Sample Output:


{
  "customEvents": [
    {
      "name": "Test custom event",
      "properties": [
        "date",
        "boolean"
      ]
    },
    {
      "name": "Chart Export",
      "properties": [
        "Destination",
        "ChartType"
      ]
    },
    {
      "name": "NUM",
      "properties": [
        "num"
      ]
    },
    {
      "name": "gil4",
      "properties": [
        "myStr",
        "myBool"
      ]
    },
    {
      "name": "testreg1",
      "properties": []
    },
    {
      "name": "ChargedBattery",
      "properties": [
        "size"
      ]
    }
  ]
}