Create Uniques Report

post

https://api.pushly.com/domains/{domain_id}/insights

Counts each subscriber once per bucket rather than once per event, so a reader active on five days counts once in a month and five times across five days. Totals therefore do not add up across buckets, and a monthly figure is smaller than the sum of its days.
Unlike the other reports this one has no entity-specific path; name the entity in the body.

Path Params

domain_id

integer

required

Defaults to 1234

Domain ID

Query Params

force_json

integer

enum

Return the report inline instead of storing it and returning a download URL.
A report is delivered as a URL by default, because a large one does not fit in a single response. Setting this returns the rows in the response body instead, which suits a caller that wants to act on them immediately and knows its request is narrow enough to fit — a request that is not will fail rather than truncate, so narrow the date window, name specific entities, or ask for fewer fields.
Server-side pagination does not apply to an inline report: the response carries every matching row.

Allowed:

Body Params

entity

string

enum

required

Defaults to monthly_uniques

The type of reporting to query. Each grain is counted by its own rollup, so the entity selects the grain: monthly_uniques counts a subscriber once per calendar month and daily_uniques once per day.

Allowed:

breakdowns

array of strings

Defaults to domain

Determines the cardinality / dimension of how requested fields are grouped:

domain: Results will be reported at the domain level
channel: Results broken down by the delivery channel (WEB, NATIVE_IOS, NATIVE_ANDROID)
placement: Adds device type (Desktop, Mobile, Tablet) breakdown

A subscriber counted once overall may appear in two breakdown rows if they were active on both, so a broken-down report sums to more than the same report without it.

breakdowns

Allowed:

date_increment

string

enum

Defaults to month

The size of each time bucket. Only the two grains a uniques rollup is built at are accepted; anything else is rejected rather than answered, because a unique count summed across buckets counts a returning subscriber more than once.

Allowed:

date_range

object

The range of dates that should be queried for this report. Omit it to report all time, which is the usual shape for a monthly report.

fields

array of strings

Defaults to domain_id,impressions,clicks,ctr_decimal,permissions_shown,subscriptions

A list of the fields that should be included in the report

fields

Responses

400

Bad Request

403

Forbidden

Language

Credentials

Loading…

Response

Choose an example:

application/json

200Report was successfully created