Skip to navigation

List Attribution Events

Retrieve the attribution events Kard stores for transaction matching, newest eventDate first. These are the activations and impressions that count toward matching, plus every activate and boost sent through the CTA endpoints. It is not a log of every impression, view or click.

filter[startDate] and filter[endDate] are required when filter[userId] is not provided, with a window of 31 days at most.

Required scopes: rewards/attributions.read

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired
Your issuer organization ID, provided by Kard

Query parameters

filter[userId]stringOptional
Return events for this user only
filter[type]enumOptional
Return events of this attribution type only
Allowed values:
filter[entityId]stringOptional

The offer, notification or slot ID, depending on filter[type]. To look up an offer, use it with filter[type]=offerAttribution.

filter[eventCode]enumOptional
Return events with any of these event codes
Allowed values:
filter[medium]enumOptional
Return events with any of these mediums
filter[rank]integerOptional

Match state.rank, the offer’s position in the list when the event happened. Only events recorded after this endpoint launched carry state.

filter[placementId]stringOptional

Match state.placementId. Only events recorded after this endpoint launched carry state.

filter[startDate]datetimeOptional

Return events with eventDate at or after this time (ISO 8601, inclusive)

filter[endDate]datetimeOptional

Return events with eventDate before this time (ISO 8601, exclusive)

page[after]stringOptional

Cursor for forward pagination (next page), taken from links.next.

page[before]stringOptional

Cursor for backward pagination (previous page), taken from links.prev.

page[size]integerOptional
Number of items per page. Defaults to 10 if not specified and maximum value allowed 100 items per page.

Response

This endpoint returns an object.
datalist of objects

Errors

400
Invalid Request
401
Unauthorized Error
429
Too Many Requests Error
500
Internal Server Error