The identity and technical contract details declared by the specification.
FillingStrategy
string
Target group filling strategy.
MonetaryAmount
object
Represents a monetary value, including the amount and its currency.
3 properties
FieldingRunEndAt
string
The timestamp the fielding run is scheduled to end at (RFC3339 UTC format, 3 fractional digits). The end time has to be after the starting time.
TargetGroupFieldingSpecification
object
Contains Target Group fielding details.
2 properties
2 required
TargetGroupClientSideReEntryAttribute
object
An attribute of the re-entry configuration that applies on the client side.
1 property
1 required
ConversionRate
number
The current conversion rate of the target group.
QuestionID
integer
The unique identifier for a profiling question.
ProfileTargetsSelectionConditionsV3
object
A profiling condition that targets a specific answer option (e.g. gender).
3 properties
3 required
TargetGroupOverview
object
Basic attributes and statistics of a Target Group.
20 properties
15 required
TargetGroupExclusionEnabled
boolean
Whether or not the given target groups exclusion status within the given exclusion policy is set to active
FieldingAssistantModulesAssignmentRequestModel
object
Having an assignment enables Fielding Assistant modules on a specified target group. All modules are optional, their omission means they are not enabled.
4 properties
ExclusionEntityType
string
Indicates the entity type of the excluded element. Possible values are RID (Respondent ID) or CID (Access Respondent GUID)
RateCard
object
The CPI is derived from the rate card (also known as the pricing table), using the Estimated Length of Interview (LOI) and Incidence Rate (IR) of your Target G…
3 properties
3 required
SupplierResponse
object
2 properties
CompletesGoal
number
Specifies the target group's required number of survey completions or pre-screen responses. Formerly referred to as the "filling goal," this value sets the ben…
TargetGroupName
string
A human-readable name for the target group.
ProfileTargetsRangeConditionsV3
object
A profiling condition that targets a numeric range (e.g. age).
4 properties
4 required
InvalidParam
object
Describes a single invalid parameter in a request.
2 properties
2 required
FieldingRunStartAt
string
The timestamp the fielding run is scheduled to start at(RFC3339 UTC format, 3 fractional digits). The start time cannot be in the past.
ProfileTemplateIdWithProfileAdjustmentType
object
2 properties
2 required
ModuleAdaptivePacing
object
Increments quotas in regular intervals, recalculating steps after each interval to evenly pace the rest of the Completes Goal until the end date.
2 properties
2 required
ProfilingDraftRequest
object
2 properties
2 required
RateCardData
object
5 properties
UserID
string
A unique identifier for the user.
BoundRateCard
object
The CPI is derived from the rate card (also known as the pricing table), using the Estimated Length of Interview (LOI) and Incidence Rate (IR) of your Target G…
3 properties
3 required
Traceparent
string
The traceparent header carries essential trace context information. This includes the trace ID and parent span ID as defined by the W3C trace context specifica…
TargetGroupCustomerReferenceNumber
string
A customer-provided reference number for the target group.
InterlockProfileConditionsV3
A polymorphic object representing a single profiling condition, which can be a selection, range, or openended type.
DropOffRate
number
Current drop-off rate of the Target Group.
TargetGroupStatistics
object
Statistics relevant for the Target Group, each statistic might include one or more issue descriptors.
9 properties
1 required
BusinessUnitIDWithReference
string
Determines the currency used for the Target Group. Get a list of all available business units [here](tag/Definitions/operation/getbusinessunits).
ExclusionEntityID
string
Indicates the entity identifier of the excluded element
IncidenceRate
number
Current incidence rate of the Target Group.
ModuleSoftLaunch
object
Manages a soft launch of a target group. During a soft launch, pacing modules are ignored.
3 properties
3 required
StudyTypeCode
string
Uniquely identifies the Study Type that indicates the Target Group limits and purpose.
CreateDraftAllocationSpecificationGroupRequest
object
Create allocation specification request object. Allowing you to set which suppliers are blocked, how the allocated suppliers are distributed into groups, and w…
2 properties
1 required
TargetGroupsListItem
object
An individual Target Group in a list of Target Groups, with basic information and statistics.
12 properties
7 required
ProfileTargetsOpenEndedConditionsV3
A profiling condition that targets open-ended text values.
ComputeTargetGroupTransitionsFilters
object
Filters for computing target group transitions.
3 properties
TargetGroupReEntryAttributeConfig
object
An object that defines whether to allow re-entry for either the current target group, or for other target groups in the same project. However, only those other…
2 properties
2 required
TargetGroupCollectsPII
boolean
Indicates whether or not the target group collects Personally Identifiable Information (PII).
NextCursor
stringnull
An identifier for pagination that indicates there are more items available. When present, use this value to retrieve the next page of results.
TargetGroupRespondentActivityExclusionsRequest
array
The list of target groups and projects whose respondents should be excluded from this target group's survey.
IndustryCode
string
Uniquely identifies the industry with which this Target Group is associated.
TargetGroupsList
object
Paginated list of Target Groups.
4 properties
3 required
TargetGroupStatisticsIssueType
string
The type of issue.
BusinessUnitID
string
The unique ID of the business unit, which determines the currency used for the target group.
TargetGroupHumanReadableID
string
The target group's human-readable ID. This ID is unique within the scope of an account.
IncrementInterval
string
The duration between each quota increment, in ISO-8601 format. Key details: Format: Must follow the PnDTnHnMnS pattern (e.g., P1D for one day, PT12H for 12 hou…
ComputeTargetGroupTransitionsRequest
object
Request body for computing target group transitions.
4 properties
CostPerInterviewUpdateRequest
object
Cost per interview update request.
1 property
1 required
FetchTargetGroupResponse
object
Response object for a target group.
27 properties
MedianLengthOfInterviewSeconds
integer
Current median length of interview of the Target Group in seconds.
ProfileTargetsResponseRangeConditionsV3
object
6 properties
4 required
TargetGroupStatisticsIssuesSuggestion
object
2 properties
2 required
TargetGroupLinks
object
1 property
TargetGroupCollectedCompletesAggregatedIntervals
object
2 properties
2 required
SoftLaunchAssisted
boolean
Assists the target group with soft launch functionality.
LocaleCode
string
Unique text code of the locale.
FieldingAssistantModulesAssignment
object
A container for all enabled Fielding Assistant modules for a target group. Each module is optional; if a module is omitted or set to null, it is considered dis…
4 properties
SupplierIds
array
A list of unique supplier identifiers.
RespondentActivityExclusionsIDsListResponse
object
3 properties
TargetGroupID
string
A unique identifier for the target group, in ULID format.
ReEntryConfiguration
object
The re-entry configuration of a Target Group.
7 properties
7 required
TargetGroupExclusionObject
object
2 properties
AverageCostPerInterview
object
Average Cost per Interview for the Target Group.
TargetGroupOverviewByTargetGroupId
object
Basic attributes and statistics of a Target Group.
22 properties
18 required
TargetGroupClientAndScreenerSideReEntryAttribute
object
An attribute of the re-entry configuration that applies on both the client side and screener side.
2 properties
2 required
TargetGroupChangeType
string
ExclusionEntityList
object
2 properties
TargetGroupIndustryLockoutCode
string
Blocks respondents during a certain timeframe based on whether they've taken a separate Target Group in the same industry.
ProfilingDraftResponse
object
2 properties
2 required
PredictedRateCard
object
The CPI is derived from the rate card (also known as the pricing table), using the Estimated Length of Interview (LOI) and Incidence Rate (IR) of your Target G…
3 properties
3 required
TargetGroupIndustryLockoutCodeWithReference
string
Blocks respondents during a certain timeframe based on whether they've taken a separate Target Group in the same industry. Get a list of all available lockout…
RequestDraftRegularProfileV3
TargetGroupDetailsUpdateRequest
object
The Target Group update request.
9 properties
7 required
CreateDraftTargetGroupRequest
object
Request body for creating a target group in draft status.
24 properties
11 required
LocaleCodeWithReference
string
Unique text code of the locale. Get a list of all available locales [here](tag/Definitions/operation/getlocales).
TargetGroupStatisticsIssuesSuggestions
array
List of suggestions how to remedy the issues on the statistic.
QuotaOverlayBalanceFill
boolean
Does not let quotas fill faster than the others within the same demography.
PacingIncrementInterval
string
Positive duration between increment intervals. Limited to a subset of ISO-8601 duration in format PnDTnHnMnS (Java Duration without fractional seconds). The du…
TargetGroupChangelogBatch
object
4 properties
TargetGroupChangelogList
object
2 properties
ProfileTargetsResponseOpenEndedConditionsV3
ModuleGeminiPacing
object
Always collects at most as many completes on each quota, as were collected on an exposed target group. Intended for Measurement control target groups.
2 properties
2 required
MonetaryAmountRequestModel
object
Represents a monetary value, including the amount and its currency.
2 properties
ModuleLinearPacing
object
Paces fielding by incrementing the completes goal in regular intervals until the target group's end date.
2 properties
2 required
TargetGroupStatusChangeReasonCode
string
The reason code for the status change.
EarningsPerClickPerMinute
object
Earnings per Click divided by median length of interview in minutes.
StatisticsIssuesArray
array
List of issues.
RespondentActivityExclusionsIDsListRequest
object
3 properties
2 required
TargetGroupClientCpiMonetaryAmount
This property can only be defined on a Target Group with dynamic pricing. This property must not be defined on Target Groups with rate card pricing.
IndustryCodeWithReference
string
Uniquely identifies the industry with which this Target Group is associated. Get a list of all available industries [here](tag/Definitions/operation/getindustr…
TargetGroupProgress
object
Measurement of the type and progress of the Target Group. A Target Group is considered fulfilled when the fillinggoal has been reached.
4 properties
4 required
GetDraftSupplyAllocationGroupResponse
object
2 properties
ProfilingDraftRequestWithTemplate
object
3 properties
3 required
ComputeTargetGroupTransitionsResponse
object
Matching target group Id with their possible transitions.
6 properties
TargetGroupSearchString
string
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 partia…
TargetGroupExpectedLengthOfInterview
integer
Expected median length of interview of the Target Group.
TargetGroupClientCpiMonetaryAmountRequestModel
This property can only be defined on a Target Group with dynamic pricing. This property must not be defined on Target Groups with rate card pricing.
ProfilingDraftResponseWithTemplate
object
3 properties
3 required
UpdateDraftSupplyAllocationGroupRequest
object
2 properties
1 required
RequestDraftQuotaNominalV3
object
Profile target with condition or conditions and nominal value in quota.
2 properties
2 required
CostPerInterviewUpdateResponse
object
Response for cost per interview update.
1 property
1 required
TargetGroupCpi
Target group CPI.
TargetGroupStatisticIssueReason
object
2 properties
2 required
SoftLaunchEndDate
string
The soft launch will be finished at this date, and the target group paused regardless of the fill.
TargetGroupPricingModel
string
Denotes the pricing model setting for the target group based on the business unit.
ModuleDynamicPricing
object
Controls the Cost Per Interview (CPI) to achieve a 100% fill rate by the target group's end date as cost-effectively as possible. Key behaviors: Prerequisite:…
4 properties
1 required
TargetGroupLiveUrl
string
The link into the study that the respondent gets redirected to upon qualification. Note: This url must be HTTPS.
RequestDraftQuotaV3
A request targets block must be one of: • a nominal target based on profile adjustement type (see RequestDraftGroupedQuotaNominalV3) • a percentage target base…
CreatedDraftTargetGroupResponse
object
Response for creating draft target Group.
1 property
1 required
DraftTargetGroupLinks
object
1 property
TargetGroupDetails
object
Contains Target Group details.
20 properties
14 required
TargetGroupsDraftQuotaDetailsV3
TargetGroupStatisticIssue
object
Issue connected to a target group statistic
3 properties
2 required
BusinessUnitIDAsInteger
integer
Determines the currency used for the Target Group.
StudyTypeCodeWithReference
string
Uniquely identifies the Study Type that indicates the Target Group limits and purpose. Get a list of all available Study Types [here](tag/Definitions/operation…
TargetGroupCpiRequestModel
Target group CPI.
PacingStrategy
string
The pacing strategy.
RequestDraftNoQuotaV3
object
No quotas specified. The request will proceed without applying any quotas.
2 properties
2 required
LastCompleteDate
string
The timestamp the Target Groups latest complete was received (RFC3339 UTC format, 3 fractional digits).
TargetGroupExpectedIncidenceRate
number
Expected incidence rate of the Target Group.
TargetGroupFillingGoal
integer
Indicates the new value for filling goal.
schemas-TargetGroupStatus
array
ProjectID
string
The character string representing a unique project ID (ULID format).
TargetGroupsDraftQuotaV3
array
EarningsPerClick
object
Current Cost per Interview multiplied by completes so far, divided by the number of entrants.
ModuleRateCardPricing
object
Manages pricing for a target group that uses a rate card model. This module cannot be used with dynamic pricing.
3 properties
1 required
CurrencyCode
string
The three-letter ISO 4217 currency code, in uppercase. The code must correspond to a currency supported by Cint Exchange.
SoftLaunchFillingGoalPercentage
integer
The percentage of the full filling goal to collect during the soft launch phase.
RequestDraftQuotaPercentageV3
object
Profile target with condition or conditions and percentage value in quota.
2 properties
2 required
TargetGroupCollectedCompletesAggregatedIntervalsResponse
object
1 property
1 required
ProfileTargetsResponseSelectionConditionsV3
object
5 properties
3 required
TargetGroupTestUrl
string
The test link into the study that the respondent gets redirected to upon qualification. Note: This url must be HTTPS.
FillingStrategyUpdateRequest
object
Filling strategy update request.
1 property
1 required
PricingAssistance
string
Assist the pricing of the target group.
TargetGroupLanguage
array
TargetGroupClientID
integernull
Client ID associated with the created Target Group
ModuleQuotaOverlay
object
Controls how the overall completes goal is distributed across the target group's quotas.
2 properties
2 required
QuotaOverlayPreventOverfilling
boolean
Applies a translation to prescreen quota calculation type, that prevents overfills.
TargetGroupStatus
string
Target Group Status.
TargetGroupIds
array
An array of unique target group identifiers to be processed in a bulk job.
AccountID
integer
The account's unique identifier.
ResponseProfileConditionsV3
UpdateDraftTargetGroupRequest
object
Request body for updating a target group in draft status.
24 properties
11 required
TargetGroupRespondentActivityExclusionsResponse
array
The list of target groups and projects whose respondents should be excluded from this target group's survey.
TargetGroupCpiNote
CPI note is mainly used for information purposes to track internal margin. This property can only be defined on a Target Group with dynamic pricing.
SoftLaunchDemographicsStrictnessPercentage
integer
Controls how strictly should the soft launch demographics distribution follow the distribution in the full launch. A setting of 100% aims to fully match the de…
FillingStrategyUpdateResponse
object
Response for filling strategy update.
1 property
1 required
Tracestate
string
The tracestate header provides additional contextual information to the traceparent header. This enriches the tracing context and offers more fine-grained cont…
PacingGeminiExposedTargetGroupId
string
A 128 bit ULID. 26 characters, consisting of 10 characters representing the timestamp at the time of creation, and 16 characters for randomness.
TargetGroupScreenerSideReEntryAttribute
object
An attribute of the re-entry configuration that applies on the screener side.
1 property
1 required
Error
object
The standard error object returned for all failed API requests.
4 properties
2 required
QuotaOverlayAssisted
boolean
Assists the target group with quota overlay functionality.
RespondentAnalysisStatusCodes
object
Respondent analysis grouped status codes and counts.
4 properties
TargetGroupPerformance
object
Display key statistics about performance of a target group.
10 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cint publishes across the network.