gainsight-px-rest-api
GET /v1/events/email

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
< Less than
<= Less than or equal
> Greater than
>= 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 array[string]

    Filters

  • pageSize integer(int32)

    Number of events per page

    Minimum value is 1, maximum value is 1000. Default value is 25.

  • scrollId string

    Used for fetching subsequent pages after the first one. Returned in response.scrollId

  • sort string

    Sort fields

Responses

  • 200 */*

    Success

    Hide response attributes Show response attributes object
    • results array[object]

      Array of result records

      Hide results attributes Show results attributes object

      Email Event object

      • eventId string
      • identifyId string Required
      • propertyKey string Required
      • date integer(int64)
      • eventType string
      • userType string Required

        Values are LEAD, USER, VISITOR, or EMPTY_USER_TYPE.

      • globalContext object
      • engagementId string
      • email string
      • emailTrackType string

        Values are 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, or EMAIL_TRACK_UNSUBSCRIBE.

      • status string
      • reason string
      • bounceType string

        Values are EMPTY_BOUNCE_TYPE, DELIVER_BOUNCE, DELIVER_BLOCKED, or DELIVER_EXIPERED.

      • mtaResponse string
      • attempt string
      • linkIndex integer(int32)
      • linkType string

        Values are EMPTY_LINK_TYPE, HTML_LINK_TYPE, HEADER_LINK_TYPE, or TEXT_LINK_TYPE.

      • linkUrl string
      • inferredLocation object

        Location object

        Hide inferredLocation attributes Show inferredLocation attributes 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 object

          Coordinates object

          Hide coordinates attributes Show coordinates attributes object
          • latitude number(double)
          • longitude number(double)
    • totalHits integer(int64)

      Total number of records matching filters

    • scrollId string

      If passed on subsequent requests as the scrollId parameter, will fetch the next page
  • 400

    Bad request

  • 401

    Unauthorized or bad API Key

  • 429

    Rate limit exceeded

GET /v1/events/email 
curl \
 --request GET 'https://api.aptrinsic.com/v1/events/email'
Response examples (200) 
{
  "results": [
    {
      "eventId": "string",
      "identifyId": "string",
      "propertyKey": "string",
      "date": 42,
      "eventType": "string",
      "userType": "LEAD",
      "globalContext": {},
      "engagementId": "string",
      "email": "string",
      "emailTrackType": "EMPTY_EMAIL_TRACK_TYPE",
      "status": "string",
      "reason": "string",
      "bounceType": "EMPTY_BOUNCE_TYPE",
      "mtaResponse": "string",
      "attempt": "string",
      "linkIndex": 42,
      "linkType": "EMPTY_LINK_TYPE",
      "linkUrl": "string",
      "inferredLocation": {
        "countryName": "United States",
        "countryCode": "USA",
        "stateName": "California",
        "stateCode": "CA",
        "city": "San Mateo",
        "street": "101 Broadway",
        "postalCode": 94010,
        "continent": "NA",
        "regionName": "string",
        "timeZone": "string",
        "coordinates": {
          "latitude": 37.567147,
          "longitude": -122.324211
        }
      }
    }
  ],
  "totalHits": 42,
  "scrollId": "string"
}