List events

get

https://management-api.wonderpush.com/v1/events

This calls enables you to export all events performed, or only a subset of them.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Search and list events. This calls enables you to export all events, or only a subset of them. You can filter by user, installation, or event type, and restrict results from a given time window. For efficient deep pagination, you must use sort=none, using a large offset is highly discouraged.

The result is comprised of a data array, and a pagination object containing previous and next, two complete URLs for navigating through the result set. Always use the URLs as is and do not add or remove parameters. When doing efficient deep pagination, only the pagination.next page is available. See Pagination for more help on how to iterate over all results.

Query Params

userId

string

The userId of the events to list. Give an empty value for null, listing only events from anonymous installations. Give @EACH to match any non-null value, listing only events from non-anonymous installations. Omit the parameter not to filter.

installationId

string

The installationId of the events to list. You can alternatively use the device platform and device id joined by a colon. Note that an installationId is not a random string and is always used in pair with its associated userId, which you must provide in the userId parameter.

fields

array of strings

Comma separated list of fields to return.

fields

offset

int32

Defaults to 0

The number of first results to skip. Ignored when no sorting is provided. For an efficient deep pagination, always start at 0.

limit

int32

Defaults to 50

The number of results to return, or 0 for counting only the results. This number may be adjusted for efficient deep paginations. The actual number of results may be less for the last few pages of an efficient deep pagination.

string

The cursor identifier for fetching the next result page. You should always use the whole URL provided in the pagination.next field of the previous request response. Do not try to reuse this identifier if changing the other parameters, as it is bound to them.

sort

string

Defaults to none

How to sort the results. You can sort on multiple fields. For efficient deep pagination, you should use "none". Eg.: "-creationDate" will give you the most recent events, "installationId,creationDate" will list the events in chronological order, one installation after an other.

types

array of strings

The types of the events to list.

types

creationDateFrom

string

The minimum creationDate of the events to list.

creationDateTo

string

The maximum creationDate of the events to list.

collapsings

array of strings

The collapsing values of the events to list. Try with last and null (as JSON) or @NONE or an empty string.

collapsings

Response

200200