Difference between revisions of "QuestionnaireStatistics class"

From Catglobe Wiki
Jump to: navigation, search
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
 
|Name=<nowiki>QuestionnaireStatistics</nowiki>
 
|Name=<nowiki>QuestionnaireStatistics</nowiki>
 
|Description=<nowiki>The questionnaire statistics collection. To view information like how big a sample is used, how large is the active samples etc.</nowiki>
 
|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=
+
|InheritsFrom=object|Constructors=
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptConstructors_Template|Parameters=
 
{{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>}}
 
{{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>}}
Line 10: Line 10:
 
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
 
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
 
|Description=<nowiki>Get count of AverageInterviewSucceededTime</nowiki>}}
 
|Description=<nowiki>Get count of AverageInterviewSucceededTime</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>AverageQasCompletedTime</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 AverageQasCompletedTime</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>EstimatedTime</nowiki>|Parameters=
 
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>EstimatedTime</nowiki>|Parameters=
 
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
 
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
Line 85: Line 88:
 
{{CGscriptParameters_Template|Type=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
 
{{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>}}
 
|Description=<nowiki>Get count of TargetReachedCount</nowiki>}}
{{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=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=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>}}
 
}}
 
}}
 
  
 
=== <span style="color:#DF8621">'''Examples'''</span> ===
 
=== <span style="color:#DF8621">'''Examples'''</span> ===

Latest revision as of 07:53, 2 July 2020

QuestionnaireStatistics



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

Parent class

Inherits from object

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
  • string AverageQasCompletedTime(int QuestionnaireResourceId "The Id to get the info from") - Get count of AverageQasCompletedTime
  • 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
  • (From object) string ToString() - The string representation of the object.

Properties

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


Examples

//get number of read email (via tracking link)
array aQnaireRId = {13729};
QuestionnaireStatistics qs = new QuestionnaireStatistics(aQnaireRId);
print(qs.NumberOfEmails(13729));//11
print(qs.NumberOfReadEmails(13729));//3
print(qs.NumberOfReadEmailsSum(13729));//9

Ta.png