---
title: "Get Engagement View events"
method: GET
path: "/v1/events/engagementView"
tags: ["EngagementViewEvent"]
---

# Get Engagement View events

`GET /v1/events/engagementView`

## Request

- Base URL: `https://app.aptrinsic.com`
- URL: `https://app.aptrinsic.com/v1/events/engagementView`
- Auth: none declared
- TypeScript: <https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/docs/v1/events/engagementView/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves Engagement View events.  Supports filtering, sorting and paging.
### Filtering
The filter parameter accepts a list of semicolon-separated filters in the form: {fieldName}{operator}{fieldValue}
Filter terms within a single filter parameter are joined by a logical AND. 
Separate filter parameters are joined by a logical OR.
#### Supported filter fields
| Field   |
| ----- |
| identifyId |
| accountId |
| date |
| contentType |
| carouselState |
| guideState |
| surveyState |

#### Operators
| Operator   | Meaning  |
| ----- | -------- |
| == | Exact match |
| != | Not equal |
| &lt;  | Less than |
| &lt;= | Less than or equal |
| &gt;  | Greater than |
| &gt;= | Greater than or equal |
| ~  | Matches string, supports wildcard characters * and ? |
| !~ | Not like, supports wildcard characters * and ? |

Examples: 

| URI   | Results  |
| ----- | -------- |
| GET /v1/events/engagementView?filter=identifyId==ABC123 | Engagement View event matches for user with identifyId of 'ABC123'. |


### Sorting
The sort parameter accepts a list of semi-colon separated fields names, each with an optional dash to imply descending sort order.
#### Supported sort fields
| Field   |
| ----- |
| accountId |
| date |

Examples: 

| URI   | Results  |
| ----- | -------- |
| GET /v1/events/engagementView?sort=-date | Matches sorted by date descending. |

## Query parameters

- `filter` string[]
- `pageSize` integer
- `scrollId` string
- `sort` string

## Response `200`

Success

- EngagementAllTypesViewEventsPage
  - `results` EngagementAllTypesViewEvent[]: Array of result records
    - `eventId` string
    - `identifyId` string, required
    - `propertyKey` string, required
    - `date` integer
    - `eventType` string
    - `sessionId` string
    - `userType` 'LEAD' | 'USER' | 'VISITOR' | 'EMPTY_USER_TYPE', required
    - `accountId` string
    - `globalContext` object
    - `engagementId` string
    - `engagementTrackType` 'ENGAGEMENT_VIEW' | 'ENGAGEMENT_CLICK'
    - `contentId` string
    - `contentType` 'IN_APP_DIALOG' | 'IN_APP_GUIDE' | 'IN_APP_CAROUSEL' | 'IN_APP_SURVEY_NPS' | 'IN_APP_SURVEY_CES' | 'IN_APP_SURVEY_BOOLEAN' | 'IN_APP_SURVEY_RATING'
    - `executionDate` integer: Will be the same on all events related to a single engagement view, e.g. separate answers for multi-question surveys
    - `executionId` string: Will be the same on all events related to a single engagement view, e.g. separate answers for multi-question surveys
    - `viewEventId` string
    - `carouselState` 'VIEWED' | 'COMPLETED'
    - `slideId` string
    - `sequenceNumber` integer
    - `linkUrl` string
    - `guideState` 'VIEWED' | 'COMPLETED'
    - `stepId` string
    - `surveyState` 'VIEWED' | 'COMPLETED'
    - `contactMeAllowed` boolean
    - `score` integer
    - `comment` string
    - `questionType` string
    - `selectionIds` string[]
    - `path` string
  - `totalHits` integer: Total number of records matching filters
  - `scrollId` string: If passed on subsequent requests as the scrollId parameter, will fetch the next page

## Other responses

- `400`: Bad request
- `401`: Unauthorized or bad API Key
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api.md) - [All operations](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/revisions/e7b197b373d8?raw)