SegmentMatchEvent
Get segment match events
Retrieves segment 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 |
|---|
| segmentId |
| 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/segment_match?filter=identifyId==ABC123 | Segment 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/segment_match?sort=-accountId | Matches sorted by accountId descending. |
get/v1/events/segment_match
Request
- Base URLhttps://app.aptrinsic.com
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
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
Changes
No recorded changes to this operation across all 1 revision of this API.