CIcint
Exclusive Endpoints

Generates a price prediction

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.

post/demand/accounts/{account_id}/business-units/{business_unit_id}/generate-price-prediction

Request

Path parameters

account_idinteger required

The account's unique identifier.

Example:101
business_unit_idstring required

The unique ID of the business unit, which determines the currency used for the target group.

Example:1234

Uniquely identifies a business unit.

Request body

Example request

{
  "config": {
    "maximum_cpi": {
      "value": "2.7352",
      "currency_code": "USD"
    },
    "cpi_boost": {
      "value": "2.7352",
      "currency_code": "USD"
    },
    "country_code": "US",
    "expected_length_of_interview_minutes": 1,
    "expected_incidence_rate": 0.05
  }
}

Response

The price prediction was generated successfully.

buyer_account_idinteger required

The account's unique identifier.

buyer_business_unit_idstring required

The unique ID of the business unit, which determines the currency used for the target group.

buyer_business_unit_exchange_rate_from_usdnumber float required

The live exchange rate towards USD.

Example response

{
  "buyer_account_id": 101,
  "buyer_business_unit_id": "1234",
  "open_exchange_price": {
    "pricing_context": {
      "maximum_cpi": {
        "value": "2.7352",
        "currency_code": "USD",
        "currency_scale": 2
      },
      "cpi_boost": {
        "value": "2.7352",
        "currency_code": "USD",
        "currency_scale": 2
      },
      "rate_card_token": "MDFKSE42MDQ1RFg2Tk0wQjlBQ0Q5QVhQQzk7Nw=="
    },
    "cost_per_interview": {
      "value": "2.7352",
      "currency_code": "USD",
      "currency_scale": 2
    }
  },
  "private_exchange_prices": [
    {
      "pricing_context": {
        "maximum_cpi": {
          "value": "2.7352",
          "currency_code": "USD",
          "currency_scale": 2
        },
        "cpi_boost": {
          "value": "2.7352",
          "currency_code": "USD",
          "currency_scale": 2
        },
        "rate_card_token": "MDFKSE42MDQ1RFg2Tk0wQjlBQ0Q5QVhQQzk7Nw=="
      },
      "supplier_id": "3214",
      "cost_per_interview": {
        "value": "2.7352",
        "currency_code": "USD",
        "currency_scale": 2
      }
    }
  ]
}

Changes

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