Difference between revisions of "QuestionnaireStatistics class"

From Catglobe Wiki
Jump to: navigation, search
(Tag: visualeditor-switched)
Line 1: Line 1:
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
−
|Name=QuestionnaireStatistics
+
|Name=<nowiki>QuestionnaireStatistics</nowiki>
−
|Description=The questionnaire statistics collection. To view information like how big a sample is used, how large is the active samples etc.
+
|Description=<nowiki>The questionnaire statistics collection. To view information like how big a sample is used, how large is the active samples etc.</nowiki>
 
|Constructors=
 
|Constructors=
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptConstructors_Template|Parameters=
−
{{CGscriptParameters_Template|Type=array|Name=qids|Description=An array of questionnaire resource ids. Invalid ids are ignored. Deleted ids are ok. Must have Read permission.}}
+
{{CGscriptParameters_Template|Type=array|Name=<nowiki>qids</nowiki>|Description=<nowiki>An array of questionnaire resource ids. Invalid ids are ignored. Deleted ids are ok. Must have Read permission.</nowiki>}}
−
|Description=Constructor to take many questionnaires}}
+
|Description=<nowiki>Constructor to take many questionnaires</nowiki>}}
 
|Methods=
 
|Methods=
−
{{CGscriptMethods_Template|ReturnType=string|Name=AverageInterviewSucceededTime|Parameters=
+
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>AverageInterviewSucceededTime</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of AverageInterviewSucceededTime}}
+
|Description=<nowiki>Get count of AverageInterviewSucceededTime</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=number|Name=EstimatedTime|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>EstimatedTime</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get estimated time to complete based on current time estimate of the pq}}
+
|Description=<nowiki>Get estimated time to complete based on current time estimate of the pq</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=number|Name=EstimatedTotalTime|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>EstimatedTotalTime</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get sum of estimated time to complete based on current time estimate of the pq}}
+
|Description=<nowiki>Get sum of estimated time to complete based on current time estimate of the pq</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=DateTime|Name=FirstInterview|Parameters=
+
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>FirstInterview</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get start date of the first interview}}
+
|Description=<nowiki>Get start date of the first interview</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=DateTime|Name=LatestInterview|Parameters=
+
{{CGscriptMethods_Template|ReturnType=DateTime|Name=<nowiki>LatestInterview</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get end date of the latest interview}}
+
|Description=<nowiki>Get end date of the latest interview</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NonSampleRules|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NonSampleRules</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NonSampleRules}}
+
|Description=<nowiki>Get count of NonSampleRules</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NonSampleRulesWithData|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NonSampleRulesWithData</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NonSampleRulesWithData}}
+
|Description=<nowiki>Get count of NonSampleRulesWithData</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NonSampleRulesWithoutData|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NonSampleRulesWithoutData</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NonSampleRulesWithoutData}}
+
|Description=<nowiki>Get count of NonSampleRulesWithoutData</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NumberOfActiveNotContactedRpq|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfActiveNotContactedRpq</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NumberOfActiveNotContactedRpq}}
+
|Description=<nowiki>Get count of NumberOfActiveNotContactedRpq</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NumberOfActiveSample|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfActiveSample</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NumberOfActiveSample}}
+
|Description=<nowiki>Get count of NumberOfActiveSample</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NumberOfAvailable|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfAvailable</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NumberOfAvailable}}
+
|Description=<nowiki>Get count of NumberOfAvailable</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NumberOfAvailableActive|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfAvailableActive</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NumberOfAvailableActive}}
+
|Description=<nowiki>Get count of NumberOfAvailableActive</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NumberOfCompleted|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfCompleted</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NumberOfCompleted}}
+
|Description=<nowiki>Get count of NumberOfCompleted</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NumberOfCompletedToday|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfCompletedToday</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NumberOfCompletedToday}}
+
|Description=<nowiki>Get count of NumberOfCompletedToday</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NumberOfCompletedYesterday|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfCompletedYesterday</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NumberOfCompletedYesterday}}
+
|Description=<nowiki>Get count of NumberOfCompletedYesterday</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NumberOfEmails|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfEmails</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get number of emails sent}}
+
|Description=<nowiki>Get number of emails sent</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NumberOfInterviewSucceeded|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfInterviewSucceeded</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NumberOfInterviewSucceeded}}
+
|Description=<nowiki>Get count of NumberOfInterviewSucceeded</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NumberOfInterviewSucceededToday|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfInterviewSucceededToday</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NumberOfInterviewSucceededToday}}
+
|Description=<nowiki>Get count of NumberOfInterviewSucceededToday</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NumberOfInterviewSucceededYesterday|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfInterviewSucceededYesterday</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NumberOfInterviewSucceededYesterday}}
+
|Description=<nowiki>Get count of NumberOfInterviewSucceededYesterday</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NumberOfNotContactedRpq|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfNotContactedRpq</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NumberOfNotContactedRpq}}
+
|Description=<nowiki>Get count of NumberOfNotContactedRpq</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NumberOfPartly|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfPartly</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NumberOfPartly}}
+
|Description=<nowiki>Get count of NumberOfPartly</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NumberOfReadEmails|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfReadEmails</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get number of qas that was registered as read or started}}
+
|Description=<nowiki>Get number of qas that was registered as read or started</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NumberOfSample|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfReadEmailsSum</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NumberOfSample}}
+
|Description=<nowiki>Get number of qas that was registered as read or started as the sum of times they were opened</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=NumberOfTestLink|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfSample</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of NumberOfTestLink}}
+
|Description=<nowiki>Get count of NumberOfSample</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=int|Name=TargetReachedCount|Parameters=
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>NumberOfTestLink</nowiki>|Parameters=
−
{{CGscriptParameters_Template|Type=int|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
−
|Description=Get count of TargetReachedCount}}
+
|Description=<nowiki>Get count of NumberOfTestLink</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
+
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>TargetReachedCount</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
 +
|Description=<nowiki>Get count of TargetReachedCount</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
 
|Properties=
 
|Properties=
−
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
+
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
 
}}
 
}}
 +
  
 
=== <span style="color:#DF8621">'''Examples'''</span> ===
 
=== <span style="color:#DF8621">'''Examples'''</span> ===

Revision as of 09:23, 22 May 2017

QuestionnaireStatistics



The questionnaire statistics collection. To view information like how big a sample is used, how large is the active samples etc.

Constructors

  • (array qids "An array of questionnaire resource ids. Invalid ids are ignored. Deleted ids are ok. Must have Read permission.") - Constructor to take many questionnaires

Methods

  • string AverageInterviewSucceededTime(int QuestionnaireResourceId "The Id to get the info from") - Get count of AverageInterviewSucceededTime
  • number EstimatedTime(int QuestionnaireResourceId "The Id to get the info from") - Get estimated time to complete based on current time estimate of the pq
  • number EstimatedTotalTime(int QuestionnaireResourceId "The Id to get the info from") - Get sum of estimated time to complete based on current time estimate of the pq
  • DateTime FirstInterview(int QuestionnaireResourceId "The Id to get the info from") - Get start date of the first interview
  • DateTime LatestInterview(int QuestionnaireResourceId "The Id to get the info from") - Get end date of the latest interview
  • int NonSampleRules(int QuestionnaireResourceId "The Id to get the info from") - Get count of NonSampleRules
  • int NonSampleRulesWithData(int QuestionnaireResourceId "The Id to get the info from") - Get count of NonSampleRulesWithData
  • int NonSampleRulesWithoutData(int QuestionnaireResourceId "The Id to get the info from") - Get count of NonSampleRulesWithoutData
  • int NumberOfActiveNotContactedRpq(int QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfActiveNotContactedRpq
  • int NumberOfActiveSample(int QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfActiveSample
  • int NumberOfAvailable(int QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfAvailable
  • int NumberOfAvailableActive(int QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfAvailableActive
  • int NumberOfCompleted(int QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfCompleted
  • int NumberOfCompletedToday(int QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfCompletedToday
  • int NumberOfCompletedYesterday(int QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfCompletedYesterday
  • int NumberOfEmails(int QuestionnaireResourceId "The Id to get the info from") - Get number of emails sent
  • int NumberOfInterviewSucceeded(int QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfInterviewSucceeded
  • int NumberOfInterviewSucceededToday(int QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfInterviewSucceededToday
  • int NumberOfInterviewSucceededYesterday(int QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfInterviewSucceededYesterday
  • int NumberOfNotContactedRpq(int QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfNotContactedRpq
  • int NumberOfPartly(int QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfPartly
  • int NumberOfReadEmails(int QuestionnaireResourceId "The Id to get the info from") - Get number of qas that was registered as read or started
  • int NumberOfReadEmailsSum(int QuestionnaireResourceId "The Id to get the info from") - Get number of qas that was registered as read or started as the sum of times they were opened
  • int NumberOfSample(int QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfSample
  • int NumberOfTestLink(int QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfTestLink
  • int TargetReachedCount(int QuestionnaireResourceId "The Id to get the info from") - Get count of TargetReachedCount
  • string ToString() - The string representation of the object.

Properties

  • string ObjectTypeName { get; } - The name of the type of object.
  • TypeInformation TypeInformation { get; } - Get information about this class.


Examples

//get number of read email (via tracking link)
QuestionnaireStatistics stt = new QuestionnaireStatistics({11147517});
print(stt.NumberOfEmails(11147517));//90302
print(stt.NumberOfReadEmails(11147517));//8627
Retrieved from "http://wiki.catglobe.com/index.php?title=QuestionnaireStatistics_class&oldid=229772"