Create App Message Report

post

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

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

Defaults to app_messages

The type of reporting to query

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
app_message: Individual results by app message
channel: Results broken down by the delivery channel (NATIVE_IOS, NATIVE_ANDROID)
placement: Adds device type (Desktop, Mobile, Tablet) breakdown

Any combination of these is accepted so long as at least one is given.

breakdowns

Allowed:

date_range

object

The range of dates that should be queried for this report. Filters on when the message was seen, not on the run dates configured for it.

fields

array of strings

Defaults to app_message_id,app_message_name,impressions,clicks,ctr_decimal

A list of the fields that should be included in the report.
app_message_run_date_start and app_message_run_date_end are the window the message was configured to run for, read in app_message_run_date_time_zone.

fields

Responses

400

Bad Request

403

Forbidden

Language

Credentials

Loading…

Response

Choose an example:

application/json

200Report was successfully created