CIcint
Target Groups

List target groups for a project

Fetch a paginated list of essential data points and statistical metrics related to Target Groups of a single project, such as current status, progress, and other relevant details, based on filter criteria such as language, country, name, etc.

get/demand/accounts/{account_id}/projects/{project_id}/target-groups

Request

Query parameters

end_beforestring

Returns a list of objects that come before the provided pagination cursor. This is used for navigating to a previous page.

start_afterstring

Returns a list of objects after the provided pagination cursor, using the next_cursor from the previous response.

page_sizeinteger

A limit on the number of objects to be returned, between 1 and 100.

exclusion_statusboolean

Only return target groups with the specified exclusion status.

namestring
Example:My Target Gr

The (partial) name of the target group to match against. Supports partial and stemmed matching. This query parameter is deprecated and replaced by the search_string parameter. If only the name parameter is supplied, it will be used as if it was the search_string. If both name and search_string are supplied, name will be ignored.

search_stringstring
Example:My Target Gr

Search string to match against. The string will be used to search based on the target group's name and/or the target group's human readable ID. Supports partial matching for target group name and human readable ID. Also supports English language stemmed matching for target group name.

human_readable_idsTargetGroupHumanReadableID[]

An array of target group human readable ID's to filter by. When there are no other filter or search parameters supplied, the call will return a list of target groups that match these ID's.

[
  "9NRV3B9"
]
target_group_customer_reference_numbersTargetGroupCustomerReferenceNumber[]

An array of target group customer reference numbers to filter by. When there are no other filter or search parameters supplied, the call will return a list of target groups that match these values.

[
  "AB-00246246"
]
statusTargetGroupStatus[]

Target Group status(es) to match against.

[
  "draft"
]
countrystring[]

Target Group country or countries to match against. Get a list of all available countries here.

[
  "us"
]
languagestring[]

Target Group language(s) to match against.

[
  "eng"
]
project_manager_idstring uuid

A unique identifier for the user.

Example:b551326b-ac9d-4d32-8823-4f025787dab9

Filters the list of projects by the assigned project manager's ID.

Response

A successful response returns a paginated list of matching Target Groups along with details such as attributes and metrics.

urlstring required

URL which produced this list (without query parameters).

has_moreboolean required

If there are further results to be shown using the returned next cursor or previous cursor, this will be true, otherwise false.

next_cursorstring nullable

An identifier for pagination that indicates there are more items available. When present, use this value to retrieve the next page of results.

Changes

No recorded changes to this operation across all 1 revision of this API.