CIcint
Target Groups

Retrieve a rate card

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.

get/demand/accounts/{account_id}/business-units/{business_unit_id}/rate-card

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.

Query parameters

country_codestring required

Country code to find the rate card for.

Response

Successfully return matching Rate Card.

country_codestring required

String representing the country code.

tokenstring required

Rate card token.

Example response

{
  "country_code": "US",
  "token": "UkNUPUNPVU5UUlk6UkNWPTE2OkNDPVVT",
  "rate_card_data": {
    "data_format": "loi_ir_matrix",
    "length_of_interview_minutes": [
      3,
      6,
      10,
      15,
      20,
      25,
      30,
      35,
      40,
      45,
      50,
      55,
      60
    ],
    "incidence_rate_percents": [
      75,
      50,
      30,
      20,
      15,
      10,
      7,
      5,
      3,
      1
    ],
    "pricing_table_currency_code": "USD",
    "pricing_table_data": [
      [
        32,
        373,
        495,
        67,
        898,
        1248,
        1895,
        277,
        347,
        4695
      ],
      [
        374,
        427,
        549,
        724,
        952,
        1302,
        1949,
        2824,
        3524,
        4749
      ],
      [
        434,
        487,
        609,
        784,
        1012,
        1362,
        2009,
        2884,
        3584,
        4809
      ],
      [
        494,
        547,
        669,
        844,
        1072,
        1422,
        2069,
        2944,
        3644,
        4869
      ],
      [
        554,
        607,
        729,
        904,
        1132,
        1482,
        2129,
        3004,
        3704,
        4929
      ],
      [
        614,
        667,
        789,
        964,
        1192,
        1542,
        2189,
        3064,
        3764,
        4989
      ],
      [
        739,
        791,
        914,
        1089,
        1316,
        1666,
        2314,
        3189,
        3889,
        5114
      ],
      [
        849,
        902,
        1024,
        1199,
        1427,
        1777,
        2424,
        3299,
        3999,
        5224
      ],
      [
        972,
        1024,
        1147,
        1322,
        1549,
        1899,
        2547,
        3422,
        4122,
        5347
      ],
      [
        1056,
        1108,
        1231,
        1406,
        1633,
        1983,
        2631,
        3506,
        4206,
        5431
      ],
      [
        114,
        1192,
        1315,
        149,
        1717,
        2067,
        2715,
        359,
        429,
        5515
      ],
      [
        1224,
        1276,
        1399,
        1574,
        1801,
        2151,
        2799,
        3674,
        4374,
        5599
      ],
      [
        1308,
        136,
        1483,
        1658,
        1885,
        2235,
        2883,
        3758,
        4458,
        5683
      ]
    ]
  }
}

Changes

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