GAgainsight
Engagement

Get engagement

Retrieves the engagement with the given id

get/v1/engagement/{engagementId}

Request

Path parameters

engagementIdstring required

Engagement id

Response

Success

defaultLanguagestring
idstring required
translationStatestring
namestring required
descriptionstring
type'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' | 'IN_APP_MULTIPLE_QUESTION_SURVEY' required
state'IN_PROGRESS' | 'STARTED' | 'PAUSED' | 'FAILED' | 'EDITING' | 'COMPLETED' required
propertyKeysstring[] required

Aptrinsic Tag Key, at least one is required

envsstring[] required

A list of environments

Example response

{
  "propertyKeys": [
    "AP-XXXXXXXXXX-2"
  ],
  "envs": [
    "Production"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.