---
title: "Get Email events"
method: GET
path: "/v1/events/email"
tags: ["EmailEvent"]
---

# Get Email events

`GET /v1/events/email`

## Request

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

Retrieves Email 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 |
| date |
| email |
| engagementId |
| emailTrackType |
| executionDate |

#### 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/email?filter=identifyId==ABC123 | Email 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   |
| ----- |
| date |

Examples: 

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

## Query parameters

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

## Response `200`

Success

- EmailEventsPage
  - `results` EmailEvent[]: Array of result records
    - `eventId` string
    - `identifyId` string, required
    - `propertyKey` string, required
    - `date` integer
    - `eventType` string
    - `userType` 'LEAD' | 'USER' | 'VISITOR' | 'EMPTY_USER_TYPE', required
    - `globalContext` object
    - `engagementId` string
    - `email` string
    - `emailTrackType` 'EMPTY_EMAIL_TRACK_TYPE' | 'EMAIL_TRACK_BOUNCE' | 'EMAIL_TRACK_DEFERRED' | 'EMAIL_TRACK_DELIVERED' | 'EMAIL_TRACK_DROPPED' | 'EMAIL_TRACK_PROCESSED' | 'EMAIL_TRACK_OPEN' | 'EMAIL_TRACK_CLICK' | 'EMAIL_TRACK_UNSUBSCRIBE'
    - `status` string
    - `reason` string
    - `bounceType` 'EMPTY_BOUNCE_TYPE' | 'DELIVER_BOUNCE' | 'DELIVER_BLOCKED' | 'DELIVER_EXIPERED'
    - `mtaResponse` string
    - `attempt` string
    - `linkIndex` integer
    - `linkType` 'EMPTY_LINK_TYPE' | 'HTML_LINK_TYPE' | 'HEADER_LINK_TYPE' | 'TEXT_LINK_TYPE'
    - `linkUrl` string
    - `inferredLocation` Location: Location object
      - `countryName` string
      - `countryCode` string: See ISO 3166
      - `stateName` string
      - `stateCode` string: See ISO 3166
      - `city` string
      - `street` string
      - `postalCode` string
      - `continent` string: See ISO 3166
      - `regionName` string: See ISO 3166-2
      - `timeZone` string
      - `coordinates` Coordinates: Coordinates object
        - `latitude` number, double
        - `longitude` number, double
  - `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)