Difference between revisions of "CatiStatistic class"
| Line 1: | Line 1: | ||
{{CGscriptClass_Template | {{CGscriptClass_Template | ||
|Name=<nowiki>CatiStatistic</nowiki> | |Name=<nowiki>CatiStatistic</nowiki> | ||
| − | |Description=<nowiki> | + | |Description=<nowiki>Statistic for interviewers in a cati questionnaire.</nowiki> |
|Methods= | |Methods= | ||
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}} | ||
| Line 7: | Line 7: | ||
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>AverageSuccesTime</nowiki>|HasGetter=1|Description=<nowiki>Get AverageSuccesTime in second</nowiki>}} | {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>AverageSuccesTime</nowiki>|HasGetter=1|Description=<nowiki>Get AverageSuccesTime in second</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>FirstCall</nowiki>|HasGetter=1|Description=<nowiki>Get when first call was started inside the time period</nowiki>}} | {{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>FirstCall</nowiki>|HasGetter=1|Description=<nowiki>Get when first call was started inside the time period</nowiki>}} | ||
| − | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>InterviewerResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get | + | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>InterviewerResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get Interviewers user resource id</nowiki>}} |
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>LastCall</nowiki>|HasGetter=1|Description=<nowiki>Get when last call was finished inside the time period</nowiki>}} | {{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>LastCall</nowiki>|HasGetter=1|Description=<nowiki>Get when last call was finished inside the time period</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ModifiedRealTime</nowiki>|HasGetter=1|Description=<nowiki>Get RealTime that respects max duration of the outcome</nowiki>}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ModifiedRealTime</nowiki>|HasGetter=1|Description=<nowiki>Get RealTime that respects max duration of the outcome</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfContacts</nowiki>|HasGetter=1|Description=<nowiki>Get number of contacts called</nowiki>}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfContacts</nowiki>|HasGetter=1|Description=<nowiki>Get number of contacts called</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfInterviewSucceeded</nowiki>|HasGetter=1|Description=<nowiki>Get number of success by qas status</nowiki>}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfInterviewSucceeded</nowiki>|HasGetter=1|Description=<nowiki>Get number of success by qas status</nowiki>}} | ||
| − | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfSuccess</nowiki>|HasGetter=1|Description=<nowiki>Get number of success by outcome</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfSuccess</nowiki>|HasGetter=1|Description=<nowiki>Get number of success by outcome status</nowiki>}} |
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>RealTime</nowiki>|HasGetter=1|Description=<nowiki>Get RealTime in second</nowiki>}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>RealTime</nowiki>|HasGetter=1|Description=<nowiki>Get RealTime in second</nowiki>}} | ||
| Line 19: | Line 19: | ||
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>TotalTime</nowiki>|HasGetter=1|Description=<nowiki>Get TotalTime in second</nowiki>}} | {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>TotalTime</nowiki>|HasGetter=1|Description=<nowiki>Get TotalTime in second</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} | ||
| + | |StaticMethods= | ||
| + | {{CGscriptMethods_Template|ReturnType=Array of CatiStatistic|Name=<nowiki>CatiStatistic_getByInterviewers</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=Unknown|Name=<nowiki>interviewerUserResourceIds</nowiki>|Description=<nowiki>Which interviewers to include. May be empty to detect all participating interviewers</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Resource id of the questionnaire to search statistics for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>from</nowiki>|Description=<nowiki>Analyze from when. May be empty</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>to</nowiki>|Description=<nowiki>Analyze to when. May be empty</nowiki>}} | ||
| + | |Description=<nowiki>Fetch all statistics by interviewers</nowiki>}} | ||
| + | {{CGscriptMethods_Template|ReturnType=Array of CatiOutcomeStatistic|Name=<nowiki>CatiStatistic_getOutcomeStatistics</nowiki>|Parameters= | ||
| + | {{CGscriptParameters_Template|Type=Unknown|Name=<nowiki>interviewerUserResourceIds</nowiki>|Description=<nowiki>Which interviewers to include. May be empty to detect all participating interviewers</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Resource id of the questionnaire to search statistics for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>from</nowiki>|Description=<nowiki>Analyze from when. May be empty</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>to</nowiki>|Description=<nowiki>Analyze to when. May be empty</nowiki>}} | ||
| + | |Description=<nowiki>Fetch all statistics by interviewers</nowiki>}} | ||
}} | }} | ||
| − | |||
| − | |||
| − | |||
=== <span style="color:#DF8621">'''Examples'''</span> === | === <span style="color:#DF8621">'''Examples'''</span> === | ||
<span style="color:#DF8621"> CatiStatistic is returned when calling [[CatiStat_get]]</span> | <span style="color:#DF8621"> CatiStatistic is returned when calling [[CatiStat_get]]</span> | ||
Revision as of 04:07, 18 February 2019
CatiStatistic
Statistic for interviewers in a cati questionnaire.
Methods
- string ToString() - The string representation of the object.
Properties
- number AverageSuccesTime { get; } - Get AverageSuccesTime in second
- DateTime FirstCall { get; } - Get when first call was started inside the time period
- int InterviewerResourceId { get; } - Get Interviewers user resource id
- DateTime LastCall { get; } - Get when last call was finished inside the time period
- int ModifiedRealTime { get; } - Get RealTime that respects max duration of the outcome
- int NumberOfContacts { get; } - Get number of contacts called
- int NumberOfInterviewSucceeded { get; } - Get number of success by qas status
- int NumberOfSuccess { get; } - Get number of success by outcome status
- string ObjectTypeName { get; } - The name of the type of object.
- int RealTime { get; } - Get RealTime in second
- number SuccessRate { get; } - Get successrate in regards to ea records
- int TotalCallAttempts { get; } - Get TotalCallAttempts
- number TotalTime { get; } - Get TotalTime in second
- TypeInformation TypeInformation { get; } - Get information about this class.
Static Methods
- Array of CatiStatistic CatiStatistic_getByInterviewers(Unknown interviewerUserResourceIds "Which interviewers to include. May be empty to detect all participating interviewers", int questionnaireResourceId "Resource id of the questionnaire to search statistics for", DateTime from "Analyze from when. May be empty", DateTime to "Analyze to when. May be empty") - Fetch all statistics by interviewers
- Array of CatiOutcomeStatistic CatiStatistic_getOutcomeStatistics(Unknown interviewerUserResourceIds "Which interviewers to include. May be empty to detect all participating interviewers", int questionnaireResourceId "Resource id of the questionnaire to search statistics for", DateTime from "Analyze from when. May be empty", DateTime to "Analyze to when. May be empty") - Fetch all statistics by interviewers
Examples
CatiStatistic is returned when calling CatiStat_get
Array interviewers = {15620372, 15003004};
number qnaireRid = 15629214;
Array startDate = {2018, 2, 7, 0, 0, 0, 0};
Array endDate = {2018, 5, 10, 0, 0, 0, 0};
Array result = CatiStat_get(interviewers, qnaireRid, startDate, endDate);
print(result);//{CatiStatistic,CatiStatistic}
for(number i = 0; i<result.Count; i++ )
{
CatiStatistic catiStat = result[i];
print(catiStat.InterviewerResourceId);//15003004, 15620372
print(catiStat.TotalTime);//95280, 16740
print(catiStat.RealTime);//89294, 16372
print(catiStat.AverageSuccesTime);//1725, 2962
print(catiStat.TotalCallAttempts); //643, 116
}
