Get Analytics

get

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

Return statistics collected about various events, by event type, platform, campaign, etc

Query Params

fromDate

date

The oldest date to return statistics for.

toDate

date

The newest date to return statistics for. Defaults to now.

resolution

string

Defaults to day

Either day or hour. Returns statistics grouped day by day or hour by hour.

interval

int32

How many days or hours since fromDate or until toDate to return. Maximum 30 days or 24 hours, which is the default.

platforms

array of strings

Comma-separated list of platforms to return. Accepts @ALL and @EACH.

platforms

types

array of strings

Comma-separated list of event types to return. Accepts @EACH.

types

campaignIds

array of strings

Comma-separated list of campaignIds to return. Accepts @ALL and @EACH. Use @NONE to select campaign statistics that were not bond to any particular campaignId (aka. null campaignId).

campaignIds

notificationIds

array of strings

Comma-separated list of notificationIds to return. Accepts @ALL and @EACH. The special value @1 regroups all notifications send directly to a single recipient.

notificationIds

buttonLabels

array of strings

Comma-separated list of button labels to return. If your button label contains a comma, send your request using a JSON body instead. Accepts @ALL and @EACH.

buttonLabels

format

string

Defaults to json

Either json or csv.

flatten

string

One of counters, platforms, types, campaignIds, notificationIds and buttonLabels. Change the output from a list of counters grouped inside date objects, to list of data points style. See below for more information.

flattenPrefix

string

To avoid name clashes when transforming your custom event types into fields you can prefix them. If you give a value ending with a dot, then the JSON output will put the values as subfields of the given field name. See below for more information.

addZero

boolean

Defaults to false

Whether to ensure that no dates are missing (if no counters inside it are nonzero), and every data point contains the same fields when flattening the output.

csvEol

string

Defaults to CRLF

One of CR, LF and CRLF. What line ending flavor to use for the CSV output.

csvSeparator

string

Defaults to ,

What field separator to use. Some tools might expect ;.

csvQuotes

string

Defaults to "

What styles of quotes to use. You can use an empty value to disable quoting string fields, but you might experience corrupted output.

Response

200200