--- title: "Generates a price prediction" method: POST path: "/demand/accounts/{account_id}/business-units/{business_unit_id}/generate-price-prediction" tags: ["Exclusive Endpoints"] --- # Generates a price prediction `POST /demand/accounts/{account_id}/business-units/{business_unit_id}/generate-price-prediction` ## Request - Base URL: `https://api.cint.com/v1` - URL: `https://api.cint.com/v1/demand/accounts/{account_id}/business-units/{business_unit_id}/generate-price-prediction` - Auth: HTTP bearer Predicts the cost per interview (CPI) for a potential target group using either a `rate_card` or `dynamic` pricing model. The model you choose must match the business unit's pricing configuration. Private Exchange required. This endpoint is only available for accounts with a Private Exchange. If your account does not have this feature enabled, requests will fail with a 403 Forbiddenerror. Please contact your account manager if you need access to this functionality. ## Path parameters - `account_id` integer, required: The account's unique identifier. - `business_unit_id` string, required: The unique ID of the business unit, which determines the currency used for the target group. ## Request body - GetRedactedPricePredictionRequest: The request body for generating a price prediction. - `config` union, required: The pricing configuration. The `type` field within the object determines which model to use (`rate_card` or `dynamic`). - RateCardPredictionConfig: Configuration used for rate card pricing. - `type` 'rate_card', required: Descriptor of the pricing model type. - `maximum_cpi` MonetaryAmountRequestModel: Represents a monetary value, including the amount and its currency. - `value` string: The monetary value, represented as a string to maintain precision. - `currency_code` string: The three-letter ISO 4217 currency code, in uppercase. The code must correspond to a currency supported by Cint Exchange. - `cpi_boost` MonetaryAmountRequestModel: Represents a monetary value, including the amount and its currency. - `value` string: The monetary value, represented as a string to maintain precision. - `currency_code` string: The three-letter ISO 4217 currency code, in uppercase. The code must correspond to a currency supported by Cint Exchange. - `country_code` string, required: The two-letter country code, adhering to ISO 3166-1 alpha-2. - `expected_length_of_interview_minutes` integer, required: The expected median length of interview, in minutes. - `expected_incidence_rate` number, float, required: The expected incidence rate (IR) of the target audience, expressed as a decimal (e.g., 0.25 for 25%). - DynamicPricingPredictionConfig: Configuration used for dynamic pricing, specifying the user-requested cost per interview. - `type` 'dynamic', required: The pricing model. For this configuration, the value is always 'dynamic'. (And 'rate_card' respectively). - `user_requested_cpi` MonetaryAmountRequestModel, required: Represents a monetary value, including the amount and its currency. - `value` string: The monetary value, represented as a string to maintain precision. - `currency_code` string: The three-letter ISO 4217 currency code, in uppercase. The code must correspond to a currency supported by Cint Exchange. ## Response `200` The price prediction was generated successfully. - GetRedactedPricePredictionResponse: A price prediction containing the estimated cost per interview (CPI) for the Open Exchange and applicable Private Exchanges. - `buyer_account_id` integer, required: The account's unique identifier. - `buyer_business_unit_id` string, required: The unique ID of the business unit, which determines the currency used for the target group. - `buyer_business_unit_exchange_rate_from_usd` number, float, required: The live exchange rate towards USD. - `open_exchange_price` OpenExchangePricePrediction, required: Contains the predicted pricing details for the Cint Exchange. - `pricing_context` union, required: The pricing context used in the calculation. The `type` field within the object indicates the model (`rate_card` or `dynamic`). - DynamicPricingContext: The pricing context when a dynamic model is used. - `type` 'dynamic', required: The pricing model. For this context, the value is always 'dynamic'. - RateCardPricingContext: The pricing context when a rate card model is used. - `type` 'rate_card', required: The pricing model. For this context, the value is always 'rate_card'. - `maximum_cpi` MonetaryAmount: Represents a monetary value, including the amount and its currency. - `value` string: A decimal encapsulated in a string representing the value in the denomination indicated by the code. - `currency_code` string: The three-letter ISO 4217 currency code, in uppercase. The code must correspond to a currency supported by Cint Exchange. - `currency_scale` integer, nullable: The number of digits after the decimal separator, as defined by ISO 4217. - `cpi_boost` MonetaryAmount: Represents a monetary value, including the amount and its currency. - `value` string: A decimal encapsulated in a string representing the value in the denomination indicated by the code. - `currency_code` string: The three-letter ISO 4217 currency code, in uppercase. The code must correspond to a currency supported by Cint Exchange. - `currency_scale` integer, nullable: The number of digits after the decimal separator, as defined by ISO 4217. - `rate_card_token` string, required: An opaque token that uniquely identifies the rate card configuration used in a pricing calculation. - `cost_per_interview` MonetaryAmount, required: Represents a monetary value, including the amount and its currency. - `value` string: A decimal encapsulated in a string representing the value in the denomination indicated by the code. - `currency_code` string: The three-letter ISO 4217 currency code, in uppercase. The code must correspond to a currency supported by Cint Exchange. - `currency_scale` integer, nullable: The number of digits after the decimal separator, as defined by ISO 4217. - `private_exchange_prices` PrivateExchangePricePrediction[], required - `pricing_context` union, required: The pricing context used in the calculation. The `type` field within the object indicates the model (`rate_card` or `dynamic`). - DynamicPricingContext: The pricing context when a dynamic model is used. - `type` 'dynamic', required: The pricing model. For this context, the value is always 'dynamic'. - RateCardPricingContext: The pricing context when a rate card model is used. - `type` 'rate_card', required: The pricing model. For this context, the value is always 'rate_card'. - `maximum_cpi` MonetaryAmount: Represents a monetary value, including the amount and its currency. - `value` string: A decimal encapsulated in a string representing the value in the denomination indicated by the code. - `currency_code` string: The three-letter ISO 4217 currency code, in uppercase. The code must correspond to a currency supported by Cint Exchange. - `currency_scale` integer, nullable: The number of digits after the decimal separator, as defined by ISO 4217. - `cpi_boost` MonetaryAmount: Represents a monetary value, including the amount and its currency. - `value` string: A decimal encapsulated in a string representing the value in the denomination indicated by the code. - `currency_code` string: The three-letter ISO 4217 currency code, in uppercase. The code must correspond to a currency supported by Cint Exchange. - `currency_scale` integer, nullable: The number of digits after the decimal separator, as defined by ISO 4217. - `rate_card_token` string, required: An opaque token that uniquely identifies the rate card configuration used in a pricing calculation. - `supplier_id` string, required: The supplier ID of the private exchange supplier. - `cost_per_interview` MonetaryAmount, required: Represents a monetary value, including the amount and its currency. - `value` string: A decimal encapsulated in a string representing the value in the denomination indicated by the code. - `currency_code` string: The three-letter ISO 4217 currency code, in uppercase. The code must correspond to a currency supported by Cint Exchange. - `currency_scale` integer, nullable: The number of digits after the decimal separator, as defined by ISO 4217. ## Other responses - `400`: A request is not valid and can't be processed. - `401`: A request is unauthorized. - `403`: A requested is forbidden. - `404`: A requested resource isn't found. - `500`: A request failed due to an internal error. --- [API](https://skmtc.dev/cint/apis/demand-api.md) - [All operations](https://skmtc.dev/cint/apis/demand-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cint/apis/demand-api/revisions/30b31fabd6c6?raw)