API Reference

Create Prompt Report

post
https://api.pushly.com/domains//insights/
Path Params
integer
required
Defaults to 1234

Domain ID

Body Params
string
enum
required
Defaults to prompts

The type of reporting to query

Allowed:
breakdowns
array of strings
required
Defaults to domain,prompt

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 subscription channel (WEB, NATIVE_IOS, NATIVE_ANDROID)
  • prompt: Individual results by prompt
  • browser: A further breakdown of prompt + browser
  • placement: Adds device type (Desktop, Mobile, Tablet) breakdown
breakdowns*
date_range
object

The range of dates that should be queried for this report

fields
array of strings
required
Defaults to prompt_id,prompt_name,permissions_shown,subscriptions

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

fields*
Responses

400

Bad Request

403

Forbidden

Updated 7 months ago

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json

Updated 7 months ago