Create Journey Report

post

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

Reports on journeys, their steps, and the variants of a split test within a step.
Journeys were once called campaigns, and the wire format still carries that name: the path segment is campaigns, the entity is campaigns, and every journey field is prefixed campaign_. Those spellings are required and are the only place the old name survives.

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 campaigns

The type of reporting to query. Named for what journeys used to be called.

Allowed:

breakdowns

array of strings

Defaults to campaign

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

domain: Results will be reported at the domain level
campaign: Individual results by journey
step: Results by step within a journey
channel: Results broken down by the delivery channel (WEB, NATIVE_IOS, NATIVE_ANDROID)
variant: Results by the variants of a split test
split_test: Results by split test

Not every combination is accepted. step, variant and split_test each describe something inside a journey, so they pair with campaign and with each other only as listed: variant and split_test require campaign, and neither combines with step or with channel.
A variant or split_test breakdown also returns revision_id whether or not it was asked for. A variant keeps its id across revisions of a journey, so without the revision two rows describing different edits of the same variant cannot be told apart.

breakdowns

Allowed:

date_range

object

The range of dates that should be queried for this report

fields

array of strings

Defaults to campaign_id,campaign_name,entrances,impressions,clicks,ctr_decimal

A list of the fields that should be included in the report.
Journey fields carry the campaign_ prefix the entity is named for; campaign_name is the journey's name.

fields

Responses

400

Bad Request

403

Forbidden

Language

Credentials

Loading…

Response

Choose an example:

application/json

200Report was successfully created