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

Retrieves engagements. Supports paging. Examples:

URI Results
GET /v1/engagement?pageSize=100 Get first 100 engagements.
GET /v1/engagement?pageSize=100&pageNumber=1 Get next 100 engagements.
GET /v1/engagement?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.

  • createdById string

    Created by ID

  • 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

      • defaultLanguage string
      • id string Required
      • languages array[object]
        Hide languages attributes Show languages attributes object
        • languageCode string
        • translated boolean
      • translationState string
      • 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

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