Get feature match events

GET /v1/events/feature_match

Retrieves feature match 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
featureId
identifyId (equality only)
accountId
date

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/feature_match?filter=identifyId==ABC123	Feature 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/feature_match?sort=-accountId	Matches sorted by accountId 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
- featureMatchEvents array[object]
  
  Array of feature matches
  
  Hide featureMatchEvents attributes Show featureMatchEvents attributes object
  
  Feature Match Event
  
  eventId string
  
  identifyId string Required
  
  propertyKey string Required
  
  date integer(int64)
  
  eventType string
  
  sessionId string
  
  userType string Required
  
  Values are LEAD, USER, VISITOR, or EMPTY_USER_TYPE.
  
  accountId string
  
  globalContext object
  
  featureId string
- 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/feature_match

curl \
 --request GET 'https://api.aptrinsic.com/v1/events/feature_match'

Response examples (200)

{
  "featureMatchEvents": [
    {
      "eventId": "string",
      "identifyId": "string",
      "propertyKey": "string",
      "date": 42,
      "eventType": "string",
      "sessionId": "string",
      "userType": "LEAD",
      "accountId": "string",
      "globalContext": {},
      "featureId": "string"
    }
  ],
  "totalHits": 42,
  "scrollId": "string"
}