get-detalied
POST /supplier/v1/subsamples/{subsampleId}/get-detailed
Returns field stats and return codes to be used for field monitoring at subsample and quota level. For pending subsamples or no traffic yet, the method returns quotas with 0.
Caching: 5 minutes
| field name | description | type | required |
|---|---|---|---|
| subsampleTotal | The total number of completes needed per subsample | ||
| Quotas; quotaId | The quotas set on that specific survey and each quota ID | ||
| interviewType | |||
| 1. clicks, 2. sniffout, 3. inPrescreener, 4. sI_QI/ sC_QC, 5. prescreener_abandon, 6.prescreener_potentially_unengaged, 7.prescreen | Counts registered on prescreening part of the questionnaire; 1. total number of clicks; 2. number of sniffouts, 3. respondents on the link 4. IIS/Client screenouts 5. abandoned respondents 6. fraudulents 7. all respondents that passed the prescreening part and will continue with the client link | ||
| 1.inSurvey 2.client ScreenOut/QuotaFull 3.clientAbandon 4.clientPotentiallyUnengaged 5.erroneousComplete 6.complete | Counts registered on client part of the questionnaire; 1. completing the link 2. client screened and quotafull 3. Abandoned on client questionnaire 4. fraudulents on client questionnaire 5. Completes that failed our quality checks and will not be counted on quotas 6. Good completes | ||
| 1.remaining Exclusive/Shared 2. exclusive/shared Interviews | 1. number of completes let to achieve for both exclusive and shared 2. number of achieved completes on both shared and exclusive quotas | ||
| Actual LOI, Incidence Rate, Conversion Rate, AbandonRate | The actual values for the field metrics; questionnaire length, incidence, conversion and abandon Rate |
get-detalied returns for these quotas:
{
"subsampleTotal": 300,
"quotas": [
{
"quotaId": 76657,
"interviewType": "hard",
"clicks": 0,
"sniffout": 0,
"inPrescreener": 0,
"sI_QI": 0,
"sC_QC": 0,
"prescreener_abandon": 0,
"prescreener_potentially_unengaged": 0,
"prescreen": 0,
"inSurvey": 0,
"clientScreenOut": 0,
"clientQuotaFull": 0,
"clientAbandon": 0,
"clientPotentiallyUnengaged": 0,
"erroneousComplete": 0,
"complete": 0,
"remainingExclusive": 100,
"remainingShared": 50,
"exclusiveInterviews": 100,
"sharedInterviews": 50,
"actualClientLOI": 0,
"actualIncidenceRate": 0,
"actualClientConversionRate": 0,
"actualClientAbandonRate": 0
},
{
"quotaId": 76658,
"interviewType": "hard",
"clicks": 0,
"sniffout": 0,
"inPrescreener": 0,
"sI_QI": 0,
"sC_QC": 0,
"prescreener_abandon": 0,
"prescreener_potentially_unengaged": 0,
"prescreen": 0,
"inSurvey": 0,
"clientScreenOut": 0,
"clientQuotaFull": 0,
"clientAbandon": 0,
"clientPotentiallyUnengaged": 0,
"erroneousComplete": 0,
"complete": 0,
"remainingExclusive": 100,
"remainingShared": 50,
"exclusiveInterviews": 100,
"sharedInterviews": 50,
"actualClientLOI": 0,
"actualIncidenceRate": 0,
"actualClientConversionRate": 0,
"actualClientAbandonRate": 0
},
{
"quotaId": 76659,
"interviewType": "hard",
"clicks": 0,
"sniffout": 0,
"inPrescreener": 0,
"sI_QI": 0,
"sC_QC": 0,
"prescreener_abandon": 0,
"prescreener_potentially_unengaged": 0,
"prescreen": 0,
"inSurvey": 0,
"clientScreenOut": 0,
"clientQuotaFull": 0,
"clientAbandon": 0,
"clientPotentiallyUnengaged": 0,
"erroneousComplete": 0,
"complete": 0,
"remainingExclusive": 100,
"remainingShared": 50,
"exclusiveInterviews": 100,
"sharedInterviews": 50,
"actualClientLOI": 0,
"actualIncidenceRate": 0,
"actualClientConversionRate": 0,
"actualClientAbandonRate": 0
},
{
"quotaId": 76660,
"interviewType": "hard",
"clicks": 0,
"sniffout": 0,
"inPrescreener": 0,
"sI_QI": 0,
"sC_QC": 0,
"prescreener_abandon": 0,
"prescreener_potentially_unengaged": 0,
"prescreen": 0,
"inSurvey": 0,
"clientScreenOut": 0,
"clientQuotaFull": 0,
"clientAbandon": 0,
"clientPotentiallyUnengaged": 0,
"erroneousComplete": 0,
"complete": 0,
"remainingExclusive": 100,
"remainingShared": 50,
"exclusiveInterviews": 100,
"sharedInterviews": 50,
"actualClientLOI": 0,
"actualIncidenceRate": 0,
"actualClientConversionRate": 0,
"actualClientAbandonRate": 0
},
{
"quotaId": 76661,
"interviewType": "counting",
"clicks": 0,
"sniffout": 0,
"inPrescreener": 0,
"sI_QI": 0,
"sC_QC": 0,
"prescreener_abandon": 0,
"prescreener_potentially_unengaged": 0,
"prescreen": 0,
"inSurvey": 0,
"clientScreenOut": 0,
"clientQuotaFull": 0,
"clientAbandon": 0,
"clientPotentiallyUnengaged": 0,
"erroneousComplete": 0,
"complete": 0,
"remainingExclusive": 200,
"remainingShared": 100,
"exclusiveInterviews": 200,
"sharedInterviews": 100,
"actualClientLOI": 0,
"actualIncidenceRate": 0,
"actualClientConversionRate": 0,
"actualClientAbandonRate": 0
},
{
"quotaId": 76662,
"interviewType": "hard",
"clicks": 0,
"sniffout": 0,
"inPrescreener": 0,
"sI_QI": 0,
"sC_QC": 0,
"prescreener_abandon": 0,
"prescreener_potentially_unengaged": 0,
"prescreen": 0,
"inSurvey": 0,
"clientScreenOut": 0,
"clientQuotaFull": 0,
"clientAbandon": 0,
"clientPotentiallyUnengaged": 0,
"erroneousComplete": 0,
"complete": 0,
"remainingExclusive": 24,
"remainingShared": 12,
"exclusiveInterviews": 24,
"sharedInterviews": 12,
"actualClientLOI": 0,
"actualIncidenceRate": 0,
"actualClientConversionRate": 0,
"actualClientAbandonRate": 0
},
{
"quotaId": 76663,
"interviewType": "hard",
"clicks": 0,
"sniffout": 0,
"inPrescreener": 0,
"sI_QI": 0,
"sC_QC": 0,
"prescreener_abandon": 0,
"prescreener_potentially_unengaged": 0,
"prescreen": 0,
"inSurvey": 0,
"clientScreenOut": 0,
"clientQuotaFull": 0,
"clientAbandon": 0,
"clientPotentiallyUnengaged": 0,
"erroneousComplete": 0,
"complete": 0,
"remainingExclusive": 20,
"remainingShared": 10,
"exclusiveInterviews": 20,
"sharedInterviews": 10,
"actualClientLOI": 0,
"actualIncidenceRate": 0,
"actualClientConversionRate": 0,
"actualClientAbandonRate": 0
},
{
"quotaId": 76664,
"interviewType": "hard",
"clicks": 0,
"sniffout": 0,
"inPrescreener": 0,
"sI_QI": 0,
"sC_QC": 0,
"prescreener_abandon": 0,
"prescreener_potentially_unengaged": 0,
"prescreen": 0,
"inSurvey": 0,
"clientScreenOut": 0,
"clientQuotaFull": 0,
"clientAbandon": 0,
"clientPotentiallyUnengaged": 0,
"erroneousComplete": 0,
"complete": 0,
"remainingExclusive": 60,
"remainingShared": 30,
"exclusiveInterviews": 60,
"sharedInterviews": 30,
"actualClientLOI": 0,
"actualIncidenceRate": 0,
"actualClientConversionRate": 0,
"actualClientAbandonRate": 0
},
{
"quotaId": 76665,
"interviewType": "hard",
"clicks": 0,
"sniffout": 0,
"inPrescreener": 0,
"sI_QI": 0,
"sC_QC": 0,
"prescreener_abandon": 0,
"prescreener_potentially_unengaged": 0,
"prescreen": 0,
"inSurvey": 0,
"clientScreenOut": 0,
"clientQuotaFull": 0,
"clientAbandon": 0,
"clientPotentiallyUnengaged": 0,
"erroneousComplete": 0,
"complete": 0,
"remainingExclusive": 40,
"remainingShared": 20,
"exclusiveInterviews": 40,
"sharedInterviews": 20,
"actualClientLOI": 0,
"actualIncidenceRate": 0,
"actualClientConversionRate": 0,
"actualClientAbandonRate": 0
},
{
"quotaId": 76666,
"interviewType": "hard",
"clicks": 0,
"sniffout": 0,
"inPrescreener": 0,
"sI_QI": 0,
"sC_QC": 0,
"prescreener_abandon": 0,
"prescreener_potentially_unengaged": 0,
"prescreen": 0,
"inSurvey": 0,
"clientScreenOut": 0,
"clientQuotaFull": 0,
"clientAbandon": 0,
"clientPotentiallyUnengaged": 0,
"erroneousComplete": 0,
"complete": 0,
"remainingExclusive": 56,
"remainingShared": 28,
"exclusiveInterviews": 56,
"sharedInterviews": 28,
"actualClientLOI": 0,
"actualIncidenceRate": 0,
"actualClientConversionRate": 0,
"actualClientAbandonRate": 0
}
]
}
Updated over 4 years ago