quotas

📘

GET /supplier/v1/subsamples/{subsampleId}/quotas

The method will return all quotas for a given subsample: conditions, types and respondents remaining. This will allow a supplier to improve its targeting ability.

Caching: 5 minutes

field name	description
subsampleStatus	Subsample's status
actualClientIncidenceRate; actualClientConversionRate; actualClientAbandonRate	Incidence, conversion and abandoned rates in field
estimated Incidence	Survey's quoted incidence
questions;answers ;operator	The quota's questions; answers and it's operator
remainingExclusive; remainingShared	The amount of completes needed for both exclusive and shared
actualClientLOI;estimatedLOI	The quoted length of interview and the one in field
achievedInterviews; tableId;tableName	The number of completes achieved for that quota, it's id and ten name of the table
quotaId,quotaName; quotaType	The quota id, name and it's type
Logic apply on this method	First check the “total quota” if the “Exclusive + Shared” remaining is higher than “0” , continue with the checks on all the other quotas. The logic for all quotas should be if the “Remaining Exclusive + Remaining shared” > than “0” send sample to that quota. If the check done on the “total quota” is “0” (Remaining Exclusive + Remaining shared”) then sample should be paused.

quota method returns for this subsample:

JSON

[
  {
    "subsampleStatus": "Live",
    "actualClientIncidenceRate": 0,
    "actualClientConversionRate": 0,
    "actualClientAbandonRate": 0,
    "estimatedIncidence": 80,
    "questions": [
      {
        "answers": [
          {
            "rangeStart": "18",
            "rangeEnd": "34"
          }
        ],
        "id": -1,
        "operator": "OR",
        "locale": null
      }
    ],
    "remainingExclusive": 100,
    "remainingShared": 50,
    "actualClientLOI": 0,
    "estimatedLOI": 10,
    "achievedInterviews": 0,
    "tableId": 3740,
    "tableName": "agerange",
    "quotaId": 76657,
    "quotaName": "agerange_1-E1",
    "quotaType": "hard"
  },
  {
    "subsampleStatus": "Live",
    "actualClientIncidenceRate": 0,
    "actualClientConversionRate": 0,
    "actualClientAbandonRate": 0,
    "estimatedIncidence": 80,
    "questions": [
      {
        "answers": [
          {
            "rangeStart": "35",
            "rangeEnd": "55"
          }
        ],
        "id": -1,
        "operator": "OR",
        "locale": null
      }
    ],
    "remainingExclusive": 100,
    "remainingShared": 50,
    "actualClientLOI": 0,
    "estimatedLOI": 10,
    "achievedInterviews": 0,
    "tableId": 3740,
    "tableName": "agerange",
    "quotaId": 76658,
    "quotaName": "agerange_2-E1",
    "quotaType": "hard"
  },
  {
    "subsampleStatus": "Live",
    "actualClientIncidenceRate": 0,
    "actualClientConversionRate": 0,
    "actualClientAbandonRate": 0,
    "estimatedIncidence": 80,
    "questions": [
      {
        "answers": [
          {
            "id": 66338
          }
        ],
        "id": 12241,
        "operator": "OR",
        "locale": null
      }
    ],
    "remainingExclusive": 100,
    "remainingShared": 50,
    "actualClientLOI": 0,
    "estimatedLOI": 10,
    "achievedInterviews": 0,
    "tableId": 3741,
    "tableName": "Gender S1 - LATAM",
    "quotaId": 76659,
    "quotaName": "resp_genderfemale-E1",
    "quotaType": "hard"
  },
  {
    "subsampleStatus": "Live",
    "actualClientIncidenceRate": 0,
    "actualClientConversionRate": 0,
    "actualClientAbandonRate": 0,
    "estimatedIncidence": 80,
    "questions": [
      {
        "answers": [
          {
            "id": 66339
          }
        ],
        "id": 12241,
        "operator": "OR",
        "locale": null
      }
    ],
    "remainingExclusive": 100,
    "remainingShared": 50,
    "actualClientLOI": 0,
    "estimatedLOI": 10,
    "achievedInterviews": 0,
    "tableId": 3741,
    "tableName": "Gender S1 - LATAM",
    "quotaId": 76660,
    "quotaName": "resp_gendermale-E1",
    "quotaType": "hard"
  },
  {
    "subsampleStatus": "Live",
    "actualClientIncidenceRate": 0,
    "actualClientConversionRate": 0,
    "actualClientAbandonRate": 0,
    "estimatedIncidence": 80,
    "questions": [],
    "remainingExclusive": 200,
    "remainingShared": 100,
    "actualClientLOI": 0,
    "estimatedLOI": 10,
    "achievedInterviews": 0,
    "tableId": 3742,
    "tableName": "Total Quota",
    "quotaId": 76661,
    "quotaName": "quotaTotal",
    "quotaType": "counting"
  },
  {
    "subsampleStatus": "Live",
    "actualClientIncidenceRate": 0,
    "actualClientConversionRate": 0,
    "actualClientAbandonRate": 0,
    "estimatedIncidence": 80,
    "questions": [
      {
        "answers": [
          {
            "id": 90525
          }
        ],
        "id": 12639,
        "operator": "OR",
        "locale": null
      }
    ],
    "remainingExclusive": 24,
    "remainingShared": 12,
    "actualClientLOI": 0,
    "estimatedLOI": 10,
    "achievedInterviews": 0,
    "tableId": 3743,
    "tableName": "Region",
    "quotaId": 76662,
    "quotaName": "BR01STDREGION 1-E1",
    "quotaType": "hard"
  },
  {
    "subsampleStatus": "Live",
    "actualClientIncidenceRate": 0,
    "actualClientConversionRate": 0,
    "actualClientAbandonRate": 0,
    "estimatedIncidence": 80,
    "questions": [
      {
        "answers": [
          {
            "id": 255389
          }
        ],
        "id": 12639,
        "operator": "OR",
        "locale": null
      }
    ],
    "remainingExclusive": 20,
    "remainingShared": 10,
    "actualClientLOI": 0,
    "estimatedLOI": 10,
    "achievedInterviews": 0,
    "tableId": 3743,
    "tableName": "Region",
    "quotaId": 76663,
    "quotaName": "BR01STDREGION 2-E1",
    "quotaType": "hard"
  },
  {
    "subsampleStatus": "Live",
    "actualClientIncidenceRate": 0,
    "actualClientConversionRate": 0,
    "actualClientAbandonRate": 0,
    "estimatedIncidence": 80,
    "questions": [
      {
        "answers": [
          {
            "id": 255390
          }
        ],
        "id": 12639,
        "operator": "OR",
        "locale": null
      }
    ],
    "remainingExclusive": 60,
    "remainingShared": 30,
    "actualClientLOI": 0,
    "estimatedLOI": 10,
    "achievedInterviews": 0,
    "tableId": 3743,
    "tableName": "Region",
    "quotaId": 76664,
    "quotaName": "BR01STDREGION 3-E1",
    "quotaType": "hard"
  },
  {
    "subsampleStatus": "Live",
    "actualClientIncidenceRate": 0,
    "actualClientConversionRate": 0,
    "actualClientAbandonRate": 0,
    "estimatedIncidence": 80,
    "questions": [
      {
        "answers": [
          {
            "id": 255391
          }
        ],
        "id": 12639,
        "operator": "OR",
        "locale": null
      }
    ],
    "remainingExclusive": 40,
    "remainingShared": 20,
    "actualClientLOI": 0,
    "estimatedLOI": 10,
    "achievedInterviews": 0,
    "tableId": 3743,
    "tableName": "Region",
    "quotaId": 76665,
    "quotaName": "BR01STDREGION 5-E1",
    "quotaType": "hard"
  },
  {
    "subsampleStatus": "Live",
    "actualClientIncidenceRate": 0,
    "actualClientConversionRate": 0,
    "actualClientAbandonRate": 0,
    "estimatedIncidence": 80,
    "questions": [
      {
        "answers": [
          {
            "id": 90528
          }
        ],
        "id": 12639,
        "operator": "OR",
        "locale": null
      }
    ],
    "remainingExclusive": 56,
    "remainingShared": 28,
    "actualClientLOI": 0,
    "estimatedLOI": 10,
    "achievedInterviews": 0,
    "tableId": 3743,
    "tableName": "Region",
    "quotaId": 76666,
    "quotaName": "BR01STDREGION 4-E1",
    "quotaType": "hard"
  }
]