list_cohorts
Read-only · Idempotent
Example prompt
List all the enabled lookalike cohorts available across my workspaces.
Parameters
enum[]
Restrict to these cohort types. Omit to list all types the caller can see. Not every type is available to every caller — filtering on a type the caller can’t see returns no cohorts for it, indistinguishable from there being none, so an empty result for a given type may mean it’s unavailable rather than absent. min 1 item. each one of:
custom, lookalike, contextual, standard, classificationModel, advertiser, curated.integer (int64)
Only include cohorts with at most this many users. Omit for no upper bound. Filters on
users, which is measured over the requested workspaces, so which cohorts pass is relative to workspace_ids: a cohort empty in one workspace may have users across several, so widening the workspace set can move a cohort out of a max_users result.integer (int64)
Only include cohorts with at least this many users. Omit for no lower bound. Filters on
users, which is measured over the requested workspaces, so which cohorts pass is relative to workspace_ids: a cohort empty in one workspace may have users across several, so widening the workspace set can move a cohort into a min_users result.string
Case-insensitive substring matched against each cohort’s name. Omit to match all cohorts. If you wish to find cohorts by theme, use search_cohorts instead; this is a literal substring match, not a semantic search.
string
Opaque token from a previous response’s
next_page_token, to fetch the next page.enum
Field to order the listing by. Defaults to short_id. one of:
short_id, name, users, created_at.enum
Order direction. Defaults to ascending. one of:
asc, desc.enum
Restrict to enabled or disabled cohorts. Omit to list both. one of:
enabled, disabled.enum
Restrict to cohorts describing this kind of thing (a user, group of users, or piece of content). Omit to list all. one of:
user, user_group, content.string[]
Restrict to cohorts tagged with at least one of these tags (case-sensitive, exact match). min 1 item.
string[]
required
Workspaces whose cohorts are aggregated into a single flat list, not broken down by workspace. min 1 item.
Returns
CohortListItem[]
A page of cohorts matching the query, in the requested order (short id by default).
string
Pass as
page_token to fetch the next page. Absent on the last page. Valid for about 15 minutes from the first page, so other tool calls in between are fine.integer (int32)
required
Total cohorts matching the filters across all pages, before pagination. When a user-count filter (min_users/max_users) is set, this total is relative to the requested workspace_ids (because
users is measured over that set), so it is not comparable across calls with different workspace sets — a filtered total over more workspaces can be smaller than over one.