gainsight-px-rest-api
GET /v2/feature_ext

Query parameters

  • pageNumber integer(int32)

    Page number

    Default value is 0.

  • pageSize integer(int32)

    Number of events per page

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

  • propertyKey string

    Property Key

Responses

  • 200 */*

    OK

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

      Array of features

      Hide features attributes Show features attributes object

      Detailed Feature object

      • id string Required
      • name string Required
      • type string Required

        Values are FEATURE or MODULE.

      • parentFeatureId string
      • propertyKey string Required
      • status string

        Values are ACTIVATED or DELETED.

      • mappedElements array[object]
        Hide mappedElements attributes Show mappedElements attributes object

        Mapped Element

        • id string Required
        • name string Required
        • eventType string Required

          Values are CLICK, LINK, FORM, PAGE_VIEW, CUSTOM_EVENT, or SCREEN.

        • state string Required

          Values are ENABLED, DISABLED, or DELETED.

        • type string Required

          Values are EVENT, TAG, URL, CUSTOM_EVENT, TEXT_ELEMENT, or SCREEN.

      • featureLabels array[object]

        Array of labels associated with the feature

        Hide featureLabels attributes Show featureLabels attributes object

        Feature label object

        • id string
        • name string
        • color string
    • pageNumber integer(int32)

      Page number

    • isLastPage boolean

      True if no more records available on next page
GET /v2/feature_ext 
curl \
 --request GET 'https://api.aptrinsic.com/v2/feature_ext'
Response examples (200) 
{
  "features": [
    {
      "id": "string",
      "name": "string",
      "type": "FEATURE",
      "parentFeatureId": "string",
      "propertyKey": "string",
      "status": "ACTIVATED",
      "mappedElements": [
        {
          "id": "string",
          "name": "string",
          "eventType": "CLICK",
          "state": "ENABLED",
          "type": "EVENT"
        }
      ],
      "featureLabels": [
        {
          "id": "string",
          "name": "string",
          "color": "string"
        }
      ]
    }
  ],
  "pageNumber": 42,
  "isLastPage": true
}