GAgainsight
EmailEvent

Get Email events

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

OperatorMeaning
==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:

URIResults
GET /v1/events/email?filter=identifyId==ABC123Email 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:

URIResults
GET /v1/events/email?sort=-dateMatches sorted by date descending.
get/v1/events/email

Request

Query parameters

filterstring[]

Filters

pageSizeinteger

Number of events per page

scrollIdstring

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

sortstring

Sort fields

Response

Success

totalHitsinteger

Total number of records matching filters

scrollIdstring

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

Example response

{
  "results": [
    {
      "inferredLocation": {
        "countryName": "United States",
        "countryCode": "USA",
        "stateName": "California",
        "stateCode": "CA",
        "city": "San Mateo",
        "street": "101 Broadway",
        "continent": "NA",
        "coordinates": {
          "latitude": 37.567147,
          "longitude": -122.324211
        }
      }
    }
  ]
}

Changes

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