Get engagements with list of custom events from rules

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.

get/v1/engagement/extended

Request

Base URL
https://app.aptrinsic.com
Auth
none declared
TypeScript
https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/docs/v1/engagement/extended/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

contentTypesstring[]

Content Types

pageNumberinteger

Page number

pageSizeinteger

Number of events per page

Response

Success

pageNumberinteger

Page number

isLastPageboolean

True if no more records available on next page

Example response

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

Changes

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