gainsight-px-rest-api

Get engagements with list of custom events from rules

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://px-apidocs.gainsight.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "gainsight-px-rest-api MCP server": {
    "url": "https://px-apidocs.gainsight.com/mcp"
  }
}
Close
GET /v1/engagement/extended

Retrieves engagements with list of custom events that are used in the audience rule, either directly or indirectly via a feature match. Supports paging. Examples:

URI Results
GET /v1/engagement/extended?pageSize=100 Get first 100 engagements.
GET /v1/engagement/extended?pageSize=100&pageNumber=1 Get next 100 engagements.
GET /v1/engagement/extended?contentTypes=IN_APP_DIALOG,IN_APP_GUIDE Get dialog and guide engagements.

Query parameters

  • contentTypes array[string]

    Content Types

    Values are 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, IN_APP_MULTIPLE_QUESTION_SURVEY, or UNRECOGNIZE.

  • pageNumber integer(int32)

    Page number

    Default value is 0.

  • pageSize integer(int32)

    Number of events per page

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

Responses

  • 200 application/json

    Success

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

      Array of engagements

      Hide engagements attributes Show engagements attributes object

      Engagement object

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

        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.

      • state string Required

        Values are IN_PROGRESS, STARTED, PAUSED, FAILED, EDITING, or COMPLETED.

      • propertyKeys array[string] Required

        Aptrinsic Tag Key, at least one is required

      • envs array[string] Required

        A list of environments

      • customEvents array[object] Required

        A list of custom events that are referenced in the audience rules, also includes events indirectly referenced via a feature mapped to a custom event.

        Hide customEvents attributes Show customEvents attributes object

        Custom event metadata

        • name string Required

          Name of custom event

        • properties array[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/engagement/extended 
curl \
 --request GET 'https://api.aptrinsic.com/v1/engagement/extended'
Response examples (200) 
{
  "engagements": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "type": "EMAIL",
      "state": "IN_PROGRESS",
      "propertyKeys": [
        "AP-XXXXXXXXXX-2"
      ],
      "envs": [
        "Production"
      ],
      "customEvents": [
        {
          "name": "string",
          "properties": [
            "string"
          ]
        }
      ]
    }
  ],
  "pageNumber": 42,
  "isLastPage": true
}