get-basic

📘
POST /supplier/v1/subsamples/{subsampleId}/get-basic
Returns very basic field stats in quasi real time for field monitoring at the subsample and quota level. For pending subsamples or no traffic yet, the method returns quotas with 0.
Caching: 5 minutes

field name	description
completes	Number of completes achieved on a specific quota
subsampleStatus	Subsample status ids; We added below a list with them.
quotaId	Quota number on our data base
inPrescreener	number of respondents in the prescreening part of the questionnaire
inSurvey	number of respondents that are completing the survey
remainingExclusive	Number of completes left to achieve from the exclusive.
remainingShared	Number of completes left to achieve from the exclusive.
subsampleTotal	The total number of completes needed for the quota

subsample Status list

Subsample status_id	status_name	Description
1	Pending	Study is paused, traffic should be stopped/ no traffic should be sent.
2	Pending(do not use)	Not Applicable
3	Live	Real traffic can be sent, data collection started.
4	Complete	Field achieved, no more traffic required.
5	Canceled	Subsample no longer needed on Ipsos end.
6	Live for testing	Status is set before the study is pushed to "Live", in order to test the survey by Ipsos/Partners. No real respondent should be sent when a subsample have this status!

get-basic returns for these quotas in field

[
  {
    "completes": 0,
    "subsampleStatus": 3,
    "quotaId": 76657,
    "inPrescreener": 0,
    "inSurvey": 0,
    "remainingExclusive": 100,
    "remainingShared": 50,
    "subsampleTotal": 150
  },
  {
    "completes": 0,
    "subsampleStatus": 3,
    "quotaId": 76658,
    "inPrescreener": 0,
    "inSurvey": 0,
    "remainingExclusive": 100,
    "remainingShared": 50,
    "subsampleTotal": 150
  },
  {
    "completes": 0,
    "subsampleStatus": 3,
    "quotaId": 76659,
    "inPrescreener": 0,
    "inSurvey": 0,
    "remainingExclusive": 100,
    "remainingShared": 50,
    "subsampleTotal": 150
  },
  {
    "completes": 0,
    "subsampleStatus": 3,
    "quotaId": 76660,
    "inPrescreener": 0,
    "inSurvey": 0,
    "remainingExclusive": 100,
    "remainingShared": 50,
    "subsampleTotal": 150
  },
  {
    "completes": 0,
    "subsampleStatus": 3,
    "quotaId": 76661,
    "inPrescreener": 0,
    "inSurvey": 0,
    "remainingExclusive": 200,
    "remainingShared": 100,
    "subsampleTotal": 300
  },
  {
    "completes": 0,
    "subsampleStatus": 3,
    "quotaId": 76662,
    "inPrescreener": 0,
    "inSurvey": 0,
    "remainingExclusive": 24,
    "remainingShared": 12,
    "subsampleTotal": 36
  },
  {
    "completes": 0,
    "subsampleStatus": 3,
    "quotaId": 76663,
    "inPrescreener": 0,
    "inSurvey": 0,
    "remainingExclusive": 20,
    "remainingShared": 10,
    "subsampleTotal": 30
  },
  {
    "completes": 0,
    "subsampleStatus": 3,
    "quotaId": 76664,
    "inPrescreener": 0,
    "inSurvey": 0,
    "remainingExclusive": 60,
    "remainingShared": 30,
    "subsampleTotal": 90
  },
  {
    "completes": 0,
    "subsampleStatus": 3,
    "quotaId": 76665,
    "inPrescreener": 0,
    "inSurvey": 0,
    "remainingExclusive": 40,
    "remainingShared": 20,
    "subsampleTotal": 60
  },
  {
    "completes": 0,
    "subsampleStatus": 3,
    "quotaId": 76666,
    "inPrescreener": 0,
    "inSurvey": 0,
    "remainingExclusive": 56,
    "remainingShared": 28,
    "subsampleTotal": 84
  }
]

📘POST /supplier/v1/subsamples/{subsampleId}/get-basic

📘
POST /supplier/v1/subsamples/{subsampleId}/get-basic