v52

latestOpenAPI 3.0.3raw.githubusercontent.com2026-07-2113138232.4 KB
segments

Manually managed audience segments

Retrieve a list of manually managed audience segments.

Audience Segments Overview:

  • Audience Segments are cohorts of users grouped together for targeting announcements, features, or promotional campaign banners (Billboards).
  • This endpoint lists manual cohorts created and maintained by site administrators.
  • Requires administrator privileges.

The endpoint supports pagination, and each page will contain 30 segments by default.

get/api/segments

Query parameters

per_pageinteger

Page size (the number of items to return per page). The default maximum value can be overridden by "API_PER_PAGE_MAX" environment variable.

Response

A List of manually managed audience segments

idinteger

The ID of the segment

type_of'manual'

Marks the segment as manually managed (other types are internal)

user_countinteger

The current number of users in the segment