Create Segment Report

post

https://api.pushly.com/domains/{domain_id}/segments/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 segments

The type of reporting to query

Allowed:

breakdowns

array of strings

Defaults to segment

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

segment: Individual results by segment
domain: Adds the domain the segment belongs to

Only ["segment"] and ["domain", "segment"] are accepted; any other combination is rejected. A segment measure is meaningless without the segment, so segment is always present.

breakdowns

Allowed:

date_range

object

The range of dates that should be queried for this report. Bounds the delivery measures; size is the segment's membership as it stands now and is unaffected by the window.

fields

array of strings

Defaults to segment_id,segment_name,impressions,clicks,ctr_decimal,size

A list of the fields that should be included in the report.
segment_last_targeted_date_tz reports in the domain's own timezone and segment_last_targeted_date_utc in UTC; they describe the same moment.

fields

Responses

400

Bad Request

403

Forbidden

Language

Credentials

Loading…

Response

Choose an example:

application/json

200Report was successfully created