Create Prompt Report

Path Params
integer
required
Defaults to 1234

Domain ID

Query Params
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
string
enum
Defaults to prompts

The type of reporting to query

Allowed:
breakdowns
array of strings
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
Allowed:
date_range
object

The range of dates that should be queried for this report

fields
array of strings
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

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