Version: 2025-05-27

Target Groups

Create, update, list and other operations on Target Groups. A Target Group is the main unit of work in the Exchange.

📄️ Retrieve Target Group details

Fetch details of a launched Target Group, such as Business Unit ID, Study Type ID, Industry ID, Locale, Filling Goal, and other metadata related to the Target Group.

📄️ Get Target Group's collected completes as an aggregated time series

Returns a list of timestamps according to the aggregation interval and the Target Group's fielding period, with a count of completes collected thus far for each interval. When no interval is provided as a parameter, the endpoint defaults to an interval of 24 hours.

📄️ Get re-entry configuration for a target group

This endpoint will retrieve the current re- entry configuration of the given target group. This endpoint is not applicable for drafts, drafts will return a 404.

📄️ Retrieve a paginated list of Target Groups for a given project, based on filter criteria

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.

📄️ Performance metrics

Fetch a set of essential data points and statistical metrics related to a specific launched Target Group.

📄️ Update re-entry configuration for a target group

Update the re-entry configuration of the given target group. This endpoint is not applicable for drafts, drafts will return a 404.

📄️ Computes available target group transitions

Returns all target group Ids for the given query parameters and the available possible actions on the returned set of target groups.

📄️ Update launched Target Group details

Update a launched Target Group details, such as the Project Manager ID, Live URL, and other metadata related to the Target Group.

📄️ Update target group cost per interview

Updates the cost per interview to the value specified in the request body. The target group cannot be in draft state.

📄️ Retrieve basic attributes and stats for a target group by ID

Fetch a set of essential data points and statistical metrics related to a specific launched Target Group, such as its current status, progress, and other relevant details.

📄️ Updates the filling strategy on the given target group

Updates the filling strategy to the value specified in the request body.

📄️ Get the applicable Rate Card for the provided Target Group

Depending on the state of the Target Group, this may be a predicted Rate Card, which may be replaced by a new version before the Target Group collects completes or the actual Rate Card which is permanently associated with the Target Group. This association is made when the Target Group first goes live. Rate Cards predefine the prices that a buyer will be charged for sessions on a Target Group that fits the equivalent IR and LOI metrics. Buyers can understand the interaction of the active Rate Card on a Target Group with the statistics, price changes and available configurations such as maximum prices and price boost via help documents and guides. The Rate Card is returned as a 2D array where each row array is LOI (with the number and value of the rows defined by the length_of_interview_minutes) and each column (index within a row array) is IR in percentage with the values defined by the incidence_rate_percents field.

📄️ Find a Rate Card based on the provided parameters

Rate Cards predefine the prices that a buyer will be charged for sessions on a Target Group that fits the equivalent IR and LOI metrics. Buyers can understand the interaction of the active Rate Card on a Target Group with the statistics, price changes and available configurations such as maximum prices and price boost via help documents and guides. This API allows buyers to look up a Rate Card based on the provided search parameters. The Rate Card is returned as a 2D array where each row array is LOI (with the number and value of the rows defined by the length_of_interview_minutes) and each column (index within a row array) is IR in percentage with the values defined by the incidence_rate_percents field.