CIcint
Target Groups

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.

get/demand/target-groups/{target_group_id}/overview

Request

Response

A successful response returns requested Target Group attributes and statistics.

account_idinteger required

The account's unique identifier.

project_idstring required

The character string representing a unique project ID (ULID format).

project_namestring required

Name of the Project which contains the Target Group.

target_group_namestring required

Name of the Target Group.

human_readable_idstring

The target group's human-readable ID. This ID is unique within the scope of an account.

project_manager_idstring uuid required

A unique identifier for the user.

pricing_model'rate_card' | 'dynamic' required

Denotes the pricing model setting for the target group based on the business unit.

is_pricing_restrictedboolean required

True when there are target group CPI restrictions in place from fielding assistant, otherwise false.

status'draft' | 'scheduled' | 'live' | 'paused' | 'completed' | 'archived' required

Target Group Status.

country_codestring required

String representing country code.

language_codestring required

String representing language code.

conversion_ratenumber float required

The current conversion rate of the target group.

drop_off_ratenumber float required

Current drop-off rate of the Target Group.

incidence_ratenumber float required

Current incidence rate of the Target Group.

median_length_of_interview_secondsinteger required

Current median length of interview of the Target Group in seconds.

study_type_codestring

Uniquely identifies the Study Type that indicates the Target Group limits and purpose.

target_group_customer_reference_numberstring nullable

A customer-provided reference number for the target group.

created_atstring date-time required

Date and time when the target group was created (RFC3339 UTC format, 3 fractional digits).

Example response

{
  "account_id": 101,
  "project_id": "01BTGNYV6HRNK8K8VKZASZCFP0",
  "project_name": "Example Project",
  "target_group_name": "Example Target Group",
  "human_readable_id": "9NRV3B9",
  "project_manager_id": "b551326b-ac9d-4d32-8823-4f025787dab9",
  "progress": {
    "current_completes": 1,
    "current_prescreens": 1,
    "filling_goal": 1,
    "filling_strategy": "completes"
  },
  "is_pricing_restricted": true,
  "current_cost_per_interview": {
    "value": "2.7352",
    "currency_code": "USD",
    "currency_scale": 2
  },
  "average_cost_per_interview": {
    "value": "2.7352",
    "currency_code": "USD",
    "currency_scale": 2
  },
  "current_cost": {
    "value": "2.7352",
    "currency_code": "USD",
    "currency_scale": 2
  },
  "status": "draft",
  "country_code": "US",
  "language_code": "ENG",
  "conversion_rate": 0.05,
  "drop_off_rate": 0.05,
  "incidence_rate": 0.05,
  "median_length_of_interview_seconds": 1,
  "study_type_code": "diary",
  "target_group_customer_reference_number": "AB-00246246",
  "created_at": "2023-01-01T23:00:00.000Z"
}

Changes

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