gainsight-px-rest-api
GET /v1/feature

Retrieves features. Supports paging. Examples:

URI Results
GET /v1/feature?pageSize=100 Get first 100 features.
GET /v1/feature?pageSize=100&pageNumber=1 Get next 100 features.
GET /v1/feature?propertyKey=AP-XXXXXXXX-2-1 Get features for given property key

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 */*

    Success

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

      Array of features

      Hide features attributes Show features attributes object

      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.

      • 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
  • 400

    Bad request

  • 401

    Unauthorized or bad API Key

  • 429

    Rate limit exceeded

GET /v1/feature 
curl \
 --request GET 'https://api.aptrinsic.com/v1/feature'
Response examples (200) 
{
  "features": [
    {
      "id": "string",
      "name": "string",
      "type": "FEATURE",
      "parentFeatureId": "string",
      "propertyKey": "string",
      "status": "ACTIVATED",
      "featureLabels": [
        {
          "id": "string",
          "name": "string",
          "color": "string"
        }
      ]
    }
  ],
  "pageNumber": 42,
  "isLastPage": true
}