Difference between revisions of "CatiStatistic class"
| Line 2: | Line 2: | ||
|Name=<nowiki>CatiStatistic</nowiki> | |Name=<nowiki>CatiStatistic</nowiki> | ||
|Description=<nowiki>Statistic for interviewers in a cati questionnaire.</nowiki> | |Description=<nowiki>Statistic for interviewers in a cati questionnaire.</nowiki> | ||
| − | |Methods= | + | |InheritsFrom=object|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>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} |
|Properties= | |Properties= | ||
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>AverageSuccessTime</nowiki>|HasGetter=1|Description=<nowiki>Get AverageSuccesTime in second</nowiki>}} | {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>AverageSuccessTime</nowiki>|HasGetter=1|Description=<nowiki>Get AverageSuccesTime in second</nowiki>}} | ||
| Line 18: | Line 18: | ||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TotalCallAttempts</nowiki>|HasGetter=1|Description=<nowiki>Get TotalCallAttempts</nowiki>}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TotalCallAttempts</nowiki>|HasGetter=1|Description=<nowiki>Get TotalCallAttempts</nowiki>}} | ||
{{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|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} |
|StaticMethods= | |StaticMethods= | ||
{{CGscriptMethods_Template|ReturnType=Array of CatiStatistic|Name=<nowiki>CatiStatistic_getByInterviewers</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=Array of CatiStatistic|Name=<nowiki>CatiStatistic_getByInterviewers</nowiki>|Parameters= | ||
| − | {{CGscriptParameters_Template|Type= | + | {{CGscriptParameters_Template|Type=Array of ints|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>}} | |Description=<nowiki>Fetch all statistics by interviewers</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=Array of CatiOutcomeStatistic|Name=<nowiki>CatiStatistic_getOutcomeStatistics</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=Array of CatiOutcomeStatistic|Name=<nowiki>CatiStatistic_getOutcomeStatistics</nowiki>|Parameters= | ||
| − | {{CGscriptParameters_Template|Type= | + | {{CGscriptParameters_Template|Type=Array of ints|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>}} | |Description=<nowiki>Fetch all statistics by interviewers</nowiki>}} | ||
}} | }} | ||
Revision as of 07:26, 2 July 2020
CatiStatistic
Statistic for interviewers in a cati questionnaire.
Parent class
Inherits from object
Methods
- (From object) string ToString() - The string representation of the object.
Properties
- number AverageSuccessTime { 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
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
Static Methods
- Array of CatiStatistic CatiStatistic_getByInterviewers(Array of int 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(Array of int 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 CatiStatistic_getByInterviewers
Array interviewers = {15620372, 15003004};
number qnaireRid = 15629214;
DateTime startDate = new DateTime ("2018/2/7");
DateTime endDate = new DateTime ("2018/5/10");
Array result = CatiStatistic_getByInterviewers(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.AverageSuccessTime);//1725, 2962
print(catiStat.TotalCallAttempts); //643, 116
}
