Retrieve information about all segments belonging to a specific publication
The prefixed ID of the publication object
Optionally filter the results by the segment’s type.
Optionally filter the results by the segment’s status.
A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.
Pagination returns the results in pages. Each page contains the number of results specified by the limit
(default: 10).
If not specified, results 1-10 from page 1 will be returned.
The field that the results are sorted by. Defaults to created
created
- The time in which the segment was first created.
last_calculated
- The time that the segment last completed calculation. Measured in seconds since the Unix epoch.
The direction that the results are sorted in. Defaults to asc
asc
- Ascending, sorts from smallest to largest.
desc
- Descending, sorts from largest to smallest.
Optionally expand the response to include additional data.
stats
- Requests the most recently calculated statistics for a segment.
Segment stats are recalculated once daily around 7 a.m. UTC for dynamic segments, but can be manually recalculated at any time in the dashboard. Manual and static segments only calculate once upon upload or creation.
OK
An array of all segments.
The limit placed on the results. If no limit was specified in the request,this defaults to 10.
The page number the results are from. If no page was specified in the request, this defaults to page 1.
The total number of results from all pages.
The total number of pages.