list_cohorts
Read-only · Idempotent
Example prompt
List all the enabled lookalike cohorts available across my workspaces.
Parameters
Restrict to these cohort types. Omit to list all types the caller can see. min 1 item. each one of:
custom, lookalike, contextual, standard, classificationModel, advertiser.Only include cohorts with at most this many users. Omit for no upper bound.
Only include cohorts with at least this many users. Omit for no lower bound.
Case-insensitive substring matched against each cohort’s name. Omit to match all cohorts.
Opaque token from a previous response’s
next_page_token, to fetch the next page.Field to order the listing by. Defaults to short_id. one of:
short_id, name, users.Order direction. Defaults to ascending. one of:
asc, desc.Restrict to enabled or disabled cohorts. Omit to list both. one of:
enabled, disabled.Restrict to cohorts tagged with at least one of these tags. min 1 item.
Workspaces whose cohorts are aggregated into a single flat list, not broken down by workspace. min 1 item.
Returns
A page of cohorts matching the query, in the requested order (short id by default).
True when the listing was capped and some matching cohorts are missing (from this page and every other page of this query).
Pass as
page_token to fetch the next page. Absent on the last page. Expires shortly after the first page.Total cohorts matching the filters across all pages, before pagination.