Difference between revisions of "CATI getCallStatistics"

From Catglobe Wiki
Jump to: navigation, search
(→‎Examples)
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
'''CATI_getCallStatistics'''  
+
=CATI_getCallStatistics=
 +
[[Category:Questionnaire Functions]]
 +
__NOTOC__
  
−
Get call status statistics of questionnaire.
+
:Get call status (outcome) statistics of a CATI questionnaire.  
  
−
<br>'''Syntax&nbsp;'''
+
==Syntax==
 +
:CATI_getCallStatistics(Qnaire_RID, CATI_IsLastCall);  
  
−
&nbsp;&nbsp; CATI_getCallStatistics(questionnaireResourceID);
+
==Arguments==
 +
*number Qnaire_RID: is a number.
 +
*bool CATI_IsLastCall: If this argument is set:
 +
:- True: This function will return the outcome statistics based on the outcome of the '''last''' call of each answer sheet '''(Outcome/Total Sheets)''' of the specified qnaire.
 +
:- False: This function will return the outcome statistics based on the outcome of the '''total''' call of each answer sheet '''(Outcome/Total Calls)''' of the specified qnaire.
 +
:- Default is true
  
 +
==Return type==
 +
Dictionary
  
 +
==Examples==
 +
<source lang="javascript">
 +
CATI_getCallStatistics(37297375, true); // or CATI_getCallStatistics(37297375)
 +
Result:
 +
{
 +
    "Answer Sheet Statistics": {
 +
        "InterviewFailed": 3,
 +
        "Normal": 32
 +
    },
 +
    "Call Status Percentage": {
 +
        "Appointment - sure": N / A,
 +
        "Busy": 35.7 % ,
 +
        "Call again later (appointment)": N / A,
 +
        "Connection reached": N / A,
 +
        "Er allerede interviewet": N / A,
 +
        "Firmaet eksisterer ikke/er lukket": N / A,
 +
        "Laps - language": N / A,
 +
        "No answer": 42.9 % ,
 +
        "Not private household": 14.3 % ,
 +
        "Nummeret udgået efter max. opkaldsforsøg": N / A,
 +
        "Outside targetgroup": N / A,
 +
        "Refusal - principal": N / A,
 +
        "Refusal - time": N / A,
 +
        "Respondent not available (sick, traveling etc.)": N / A,
 +
        "Total": 100.0 % ,
 +
        "Wrong number": 7.1 %
 +
    },
 +
    "Call Status Statistics": {
 +
        "Appointment - sure": 0,
 +
        "Busy": 5,
 +
        "Call again later (appointment)": 0,
 +
        "Connection reached": 0,
 +
        "Er allerede interviewet": 0,
 +
        "Firmaet eksisterer ikke/er lukket": 0,
 +
        "Laps - language": 0,
 +
        "No answer": 6,
 +
        "Not private household": 2,
 +
        "Nummeret udgået efter max. opkaldsforsøg": 0,
 +
        "Outside targetgroup": 0,
 +
        "Refusal - principal": 0,
 +
        "Refusal - time": 0,
 +
        "Respondent not available (sick, traveling etc.)": 0,
 +
        "Total": 14,
 +
        "Wrong number": 1
 +
    }
 +
}
  
−
'''Arguments'''
+
CATI_getCallStatistics(37297375, false);
−
 
+
Result:
−
&nbsp;&nbsp;questionnaireResourceID:&nbsp; is a number.
+
{
−
 
+
    "Answer Sheet Statistics": {
−
 
+
        "InterviewFailed": 3,
−
 
+
        "Normal": 32
−
'''Return type'''
+
    },
−
 
+
    "Call Status Percentage": {
−
&nbsp;&nbsp; Dictionary type.
+
        "Appointment - sure": N / A,
−
 
+
        "Busy": 26.3 % ,
−
<br>'''Examples'''
+
        "Call again later (appointment)": N / A,
−
 
+
        "Connection reached": N / A,
−
Dictionary catiStatistic=CATI_getCallStatistics(14283643); <br>print(catiStatistic);&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+
        "Er allerede interviewet": N / A,
−
 
+
        "Firmaet eksisterer ikke/er lukket": N / A,
−
&nbsp;
+
        "Laps - language": N / A,
−
 
+
        "No answer": 57.9 % ,
−
// Result:&nbsp; {"Answer Sheet Statistics": {"InterviewFailed": 4, "Normal": 17}, "Call Status Statistics": {"Appointment (sure)": 27, "Busy": 1, "Call again later ": 20, "Connection reached": 14, "No answer": 6, "Respondent not present in fieldperiod": 1, "Wrong number (fax, modem ect.)": 3}}<br><br>  
+
        "Not private household": 10.5 % ,
−
 
+
        "Nummeret udgået efter max. opkaldsforsøg": N / A,
−
[[Category:Guidelines]]
+
        "Outside targetgroup": N / A,
 +
        "Refusal - principal": N / A,
 +
        "Refusal - time": N / A,
 +
        "Respondent not available (sick, traveling etc.)": N / A,
 +
        "Total": 100.0 % ,
 +
        "Wrong number": 5.3 %
 +
    },
 +
    "Call Status Statistics": {
 +
        "Appointment - sure": 0,
 +
        "Busy": 5,
 +
        "Call again later (appointment)": 0,
 +
        "Connection reached": 0,
 +
        "Er allerede interviewet": 0,
 +
        "Firmaet eksisterer ikke/er lukket": 0,
 +
        "Laps - language": 0,
 +
        "No answer": 11,
 +
        "Not private household": 2,
 +
        "Nummeret udgået efter max. opkaldsforsøg": 0,
 +
        "Outside targetgroup": 0,
 +
        "Refusal - principal": 0,
 +
        "Refusal - time": 0,
 +
        "Respondent not available (sick, traveling etc.)": 0,
 +
        "Total": 19,
 +
        "Wrong number": 1
 +
    }
 +
}
 +
</source>

Latest revision as of 10:25, 29 June 2012

CATI_getCallStatistics


Get call status (outcome) statistics of a CATI questionnaire.

Syntax

CATI_getCallStatistics(Qnaire_RID, CATI_IsLastCall);

Arguments

  • number Qnaire_RID: is a number.
  • bool CATI_IsLastCall: If this argument is set:
- True: This function will return the outcome statistics based on the outcome of the last call of each answer sheet (Outcome/Total Sheets) of the specified qnaire.
- False: This function will return the outcome statistics based on the outcome of the total call of each answer sheet (Outcome/Total Calls) of the specified qnaire.
- Default is true

Return type

Dictionary

Examples

CATI_getCallStatistics(37297375, true); // or CATI_getCallStatistics(37297375)
Result:
{
    "Answer Sheet Statistics": {
        "InterviewFailed": 3,
        "Normal": 32
    },
    "Call Status Percentage": {
        "Appointment - sure": N / A,
        "Busy": 35.7 % ,
        "Call again later (appointment)": N / A,
        "Connection reached": N / A,
        "Er allerede interviewet": N / A,
        "Firmaet eksisterer ikke/er lukket": N / A,
        "Laps - language": N / A,
        "No answer": 42.9 % ,
        "Not private household": 14.3 % ,
        "Nummeret udgået efter max. opkaldsforsøg": N / A,
        "Outside targetgroup": N / A,
        "Refusal - principal": N / A,
        "Refusal - time": N / A,
        "Respondent not available (sick, traveling etc.)": N / A,
        "Total": 100.0 % ,
        "Wrong number": 7.1 %
    },
    "Call Status Statistics": {
        "Appointment - sure": 0,
        "Busy": 5,
        "Call again later (appointment)": 0,
        "Connection reached": 0,
        "Er allerede interviewet": 0,
        "Firmaet eksisterer ikke/er lukket": 0,
        "Laps - language": 0,
        "No answer": 6,
        "Not private household": 2,
        "Nummeret udgået efter max. opkaldsforsøg": 0,
        "Outside targetgroup": 0,
        "Refusal - principal": 0,
        "Refusal - time": 0,
        "Respondent not available (sick, traveling etc.)": 0,
        "Total": 14,
        "Wrong number": 1
    }
}

CATI_getCallStatistics(37297375, false);
Result:
{
    "Answer Sheet Statistics": {
        "InterviewFailed": 3,
        "Normal": 32
    },
    "Call Status Percentage": {
        "Appointment - sure": N / A,
        "Busy": 26.3 % ,
        "Call again later (appointment)": N / A,
        "Connection reached": N / A,
        "Er allerede interviewet": N / A,
        "Firmaet eksisterer ikke/er lukket": N / A,
        "Laps - language": N / A,
        "No answer": 57.9 % ,
        "Not private household": 10.5 % ,
        "Nummeret udgået efter max. opkaldsforsøg": N / A,
        "Outside targetgroup": N / A,
        "Refusal - principal": N / A,
        "Refusal - time": N / A,
        "Respondent not available (sick, traveling etc.)": N / A,
        "Total": 100.0 % ,
        "Wrong number": 5.3 %
    },
    "Call Status Statistics": {
        "Appointment - sure": 0,
        "Busy": 5,
        "Call again later (appointment)": 0,
        "Connection reached": 0,
        "Er allerede interviewet": 0,
        "Firmaet eksisterer ikke/er lukket": 0,
        "Laps - language": 0,
        "No answer": 11,
        "Not private household": 2,
        "Nummeret udgået efter max. opkaldsforsøg": 0,
        "Outside targetgroup": 0,
        "Refusal - principal": 0,
        "Refusal - time": 0,
        "Respondent not available (sick, traveling etc.)": 0,
        "Total": 19,
        "Wrong number": 1
    }
}
Retrieved from "http://wiki.catglobe.com/index.php?title=CATI_getCallStatistics&oldid=24350"