Difference between revisions of "PanelStatistics class"

From Catglobe Wiki
Jump to: navigation, search
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
PanelStatistics : The panel statistics collection. To view information like how big a panel is, how it is used etc.
 
 
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
|Name=PanelStatistics
+
|Name=<nowiki>PanelStatistics</nowiki>
|Description=The panel statistics collection. To view information like how big a panel is, how it is used etc.
+
|Description=<nowiki>The panel statistics collection. To view information like how big a panel is, how it is used etc.</nowiki>
|Constructors=
+
|InheritsFrom=object|Constructors=
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=array|Name=questionnaireResourceTemplateRId|Description=Restricts the questionnaires examined to these types (required)|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=bulkmailIds|Description=Restricts the count of mails sent to those sent from these bulkmails (required)|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=groupRId|Description=Resource id of group containing all panel members|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=from|Description=From date|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=to|Description=To date|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=groupBy|Description=Return results in these groupings. 1=Week, 2=Month, 3=Quarter, 4=Year}}
+
{{CGscriptParameters_Template|Type=array|Name=<nowiki>questionnaireResourceTemplateRId</nowiki>|Description=<nowiki>Restricts the questionnaires examined to these types of questionnaires</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>bulkmailResourceTemplateRId</nowiki>|Description=<nowiki>Restricts the count of mails sent to those sent from these types of bulkmail</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>groupRId</nowiki>|Description=<nowiki>Resource id of group containing all panel members</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>from</nowiki>|Description=<nowiki>From date</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=<nowiki>to</nowiki>|Description=<nowiki>To date</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>groupBy</nowiki>|Description=<nowiki>Return results in these groupings. -1=Total, 0=day, 1=Week, 2=Month, 3=Quarter, 4=Year</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>panelCreationQuestionnaireResourceId</nowiki>|Description=<nowiki>If >0 then the endodate of qas in this questionnaire is used for creation date, otherwise the user created date is used</nowiki>}}
|Description=Create new statistics}}
+
|Description=<nowiki>Create new statistics</nowiki>}}
 
|Methods=
 
|Methods=
{{CGscriptMethods_Template|ReturnType=array|Name=CountActive|Description=Number of panel members that started a survey.}}
+
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>CountActive</nowiki>|Description=<nowiki>Number of panel members that started a qas.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountCompletedInterviews|Description=Number of panel members that completed a survey.}}
+
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>CountCompletedInterviews</nowiki>|Description=<nowiki>Number of panel members that completed a qas.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountCreated|Description=Number of panel members that was created.}}
+
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>CountCompletedInterviewsWithPoints</nowiki>|Description=<nowiki>Number of panel members that completed a qas that gave them points.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountDisabled|Description=Number of panel members that was disabled.}}
+
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>CountCreated</nowiki>|Description=<nowiki>Number of panel members that was created.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountGotInvitation|Description=Number of panel members that received an invitation.}}
+
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>CountDisabled</nowiki>|Description=<nowiki>Number of panel members that was disabled.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=CountReadInvitation|Description=Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.}}
+
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>CountEarnedPoints</nowiki>|Description=<nowiki>Number of points panel members earned</nowiki>}}
{{CGscriptMethods_Template|ReturnType=number|Name=CountTotal|Description=The number of panel members including disabled.}}
+
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>CountGotInvitation</nowiki>|Description=<nowiki>Number of panel members that received an invitation.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=array|Name=GetGroupings|Description=The groping values. E.g. week 32 in 2014 is returned as {32,2014}. Grouping by year is returned as {2014,2014}}}
+
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>CountPointsOfType</nowiki>|Parameters=
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
+
{{CGscriptParameters_Template|Type=int|Name=<nowiki>type</nowiki>|Description=<nowiki>Type of transaction: 0 for manual/scripted, 1 for orders, 2 for questionnaire, 3 for visitorsite, 4 for expired, negative for custom.</nowiki>}}
 +
|Description=<nowiki>Number of points panel members used of a given type.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>CountReadInvitation</nowiki>|Description=<nowiki>Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>CountReadInvitationSum</nowiki>|Description=<nowiki>Number times an invitation was read. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>CountTotal</nowiki>|Description=<nowiki>The number of panel members excluding disabled and deleted.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>CountUsedPoints</nowiki>|Description=<nowiki>Number of points panel members used. Included points spent on shopping and subtracted for going back in a questionnaire.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>CountUsedPointsOnOrders</nowiki>|Description=<nowiki>Number of points panel members used for shopping.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Dictionary of numbers|Name=<nowiki>DetailsActive</nowiki>|Description=<nowiki>Panel members started how many qas.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Dictionary of numbers|Name=<nowiki>DetailsCompletedInterviews</nowiki>|Description=<nowiki>Panel members completed how many qas.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Dictionary of numbers|Name=<nowiki>DetailsCompletedInterviewsWithPoints</nowiki>|Description=<nowiki>Panel members completed how many qas where each gave them some points.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Dictionary of numbers|Name=<nowiki>DetailsCreated</nowiki>|Description=<nowiki>Panel members that was created.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Dictionary of numbers|Name=<nowiki>DetailsDisabled</nowiki>|Description=<nowiki>Panel members that was disabled.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Dictionary of numbers|Name=<nowiki>DetailsGotInvitation</nowiki>|Description=<nowiki>Panel members receive how many invitations.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Dictionary of numbers|Name=<nowiki>DetailsPointsOfType</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=int|Name=<nowiki>type</nowiki>|Description=<nowiki>Type of transaction: 0 for manual/scripted, 1 for orders, 2 for questionnaire, 3 for visitorsite, 4 for expired, negative for custom.</nowiki>}}
 +
|Description=<nowiki>Number of points panel members used of a given type.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Dictionary of numbers|Name=<nowiki>DetailsReadInvitation</nowiki>|Description=<nowiki>Panel members read how many invitations. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Dictionary of numbers|Name=<nowiki>DetailsReadInvitationSum</nowiki>|Description=<nowiki>Panel members read how many invitations. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=array|Name=<nowiki>GetGroupings</nowiki>|Description=<nowiki>The grouping values. E.g. week 32 in 2014 is returned as {32,2014}. Grouping by year is returned as {2014,2014}</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>TotalAvailablePoints</nowiki>|Description=<nowiki>Sum of points panel members has available at the 'to' date</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>TotalEarnedPoints</nowiki>|Description=<nowiki>Sum of points panel members earned</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Dictionary of numbers|Name=<nowiki>TotalEarnedPointsBySurvey</nowiki>|Description=<nowiki>Dictionary of questionnaire id and number of points panel members earned for that questionnaire</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>TotalUsedPoints</nowiki>|Description=<nowiki>Sum of points panel members used</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|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
 
}}
 
}}
 +
=== Examples ===
  
Examples
+
<source lang="javascript">
  
 
array a = DateTime_getByYMD(2014,12,24); array b = DateTime_getByYMD(2015,12,24);
 
array a = DateTime_getByYMD(2014,12,24); array b = DateTime_getByYMD(2015,12,24);
  
PanelStatistics panel=new PanelStatistics({45592},{2066},69441,a,b,1); array CountActive=panel.CountActive();// - Number of panel members that started a survey. array CountCompletedInterviews=panel.CountCompletedInterviews();// - Number of panel members that completed a survey. array CountCreated=panel.CountCreated();// - Number of panel members that was created. array CountDisabled=panel.CountDisabled()// - Number of panel members that was disabled. array CountGotInvitation=panel.CountGotInvitation();// - Number of panel members that received an invitation. array CountReadInvitation=panel.CountReadInvitation();// - Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy. number CountTotal=panel.CountTotal();// - The number of panel members including disabled. array GetGroupings=panel.GetGroupings();// - The groping values. E.g. week 32 in 2014 is returned as {32,2014}. Grouping by year is returned as {2014,2014} string ToString=panel.ToString();// - The string representation of the object.
+
PanelStatistics panel=new PanelStatistics({45592},{2066},69441,a,b,1);
 +
 
 +
array CountActive=panel.CountActive();// - Number of panel members that started a survey.
 +
 
 +
array CountCompletedInterviews=panel.CountCompletedInterviews();// - Number of panel members that completed a survey.
 +
 
 +
array CountCreated=panel.CountCreated();// - Number of panel members that was created.
 +
 
 +
array CountDisabled=panel.CountDisabled()// - Number of panel members that was disabled.
 +
 
 +
array CountGotInvitation=panel.CountGotInvitation();// - Number of panel members that received an invitation.
 +
 
 +
array CountReadInvitation=panel.CountReadInvitation();// - Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.
 +
 
 +
array CountTotal=panel.CountTotal();// - The number of panel members including disabled.
 +
 
 +
array GetGroupings=panel.GetGroupings();// - The groping values. E.g. week 32 in 2014 is returned as {32,2014}. Grouping by year is returned as {2014,2014}
 +
 
 +
string ToString=panel.ToString();// - The string representation of the object.
 +
</source>
 +
<source lang="javascript">
 +
//CountReadInvitation & CountReadInvitationSum
 +
array a = DateTime_getByYMD(2017,5,29);
 +
array b = DateTime_getByYMD(2017,5,31);
 +
PanelStatistics ps = new PanelStatistics({12784},{12767},13900,a,b,1,0);
 +
print(ps.CountReadInvitation());//{3}
 +
print(ps.CountReadInvitationSum());//{9}
 +
</source>
 +
[[File:Ta.png]]

Latest revision as of 02:51, 5 November 2020

PanelStatistics



The panel statistics collection. To view information like how big a panel is, how it is used etc.

Parent class

Inherits from object

Constructors

  • (array questionnaireResourceTemplateRId "Restricts the questionnaires examined to these types of questionnaires", array bulkmailResourceTemplateRId "Restricts the count of mails sent to those sent from these types of bulkmail", int groupRId "Resource id of group containing all panel members", array from "From date", array to "To date", int groupBy "Return results in these groupings. -1=Total, 0=day, 1=Week, 2=Month, 3=Quarter, 4=Year", int panelCreationQuestionnaireResourceId "If >0 then the endodate of qas in this questionnaire is used for creation date, otherwise the user created date is used") - Create new statistics

Methods

  • array CountActive() - Number of panel members that started a qas.
  • array CountCompletedInterviews() - Number of panel members that completed a qas.
  • array CountCompletedInterviewsWithPoints() - Number of panel members that completed a qas that gave them points.
  • array CountCreated() - Number of panel members that was created.
  • array CountDisabled() - Number of panel members that was disabled.
  • array CountEarnedPoints() - Number of points panel members earned
  • array CountGotInvitation() - Number of panel members that received an invitation.
  • array CountPointsOfType(int type "Type of transaction: 0 for manual/scripted, 1 for orders, 2 for questionnaire, 3 for visitorsite, 4 for expired, negative for custom.") - Number of points panel members used of a given type.
  • array CountReadInvitation() - Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.
  • array CountReadInvitationSum() - Number times an invitation was read. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.
  • array CountTotal() - The number of panel members excluding disabled and deleted.
  • array CountUsedPoints() - Number of points panel members used. Included points spent on shopping and subtracted for going back in a questionnaire.
  • array CountUsedPointsOnOrders() - Number of points panel members used for shopping.
  • Dictionary of numbers DetailsActive() - Panel members started how many qas.
  • Dictionary of numbers DetailsCompletedInterviews() - Panel members completed how many qas.
  • Dictionary of numbers DetailsCompletedInterviewsWithPoints() - Panel members completed how many qas where each gave them some points.
  • Dictionary of numbers DetailsCreated() - Panel members that was created.
  • Dictionary of numbers DetailsDisabled() - Panel members that was disabled.
  • Dictionary of numbers DetailsGotInvitation() - Panel members receive how many invitations.
  • Dictionary of numbers DetailsPointsOfType(int type "Type of transaction: 0 for manual/scripted, 1 for orders, 2 for questionnaire, 3 for visitorsite, 4 for expired, negative for custom.") - Number of points panel members used of a given type.
  • Dictionary of numbers DetailsReadInvitation() - Panel members read how many invitations. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.
  • Dictionary of numbers DetailsReadInvitationSum() - Panel members read how many invitations. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.
  • array GetGroupings() - The grouping values. E.g. week 32 in 2014 is returned as {32,2014}. Grouping by year is returned as {2014,2014}
  • (From object) string ToString() - The string representation of the object.
  • number TotalAvailablePoints() - Sum of points panel members has available at the 'to' date
  • number TotalEarnedPoints() - Sum of points panel members earned
  • Dictionary of numbers TotalEarnedPointsBySurvey() - Dictionary of questionnaire id and number of points panel members earned for that questionnaire
  • number TotalUsedPoints() - Sum of points panel members used

Properties

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

Examples

array a = DateTime_getByYMD(2014,12,24); array b = DateTime_getByYMD(2015,12,24);

PanelStatistics panel=new PanelStatistics({45592},{2066},69441,a,b,1);

array CountActive=panel.CountActive();// - Number of panel members that started a survey.

array CountCompletedInterviews=panel.CountCompletedInterviews();// - Number of panel members that completed a survey.

array CountCreated=panel.CountCreated();// - Number of panel members that was created.

array CountDisabled=panel.CountDisabled()// - Number of panel members that was disabled.

array CountGotInvitation=panel.CountGotInvitation();// - Number of panel members that received an invitation.

array CountReadInvitation=panel.CountReadInvitation();// - Number of panel members that read an invitation. This number depends on emails using the tracking feature, and is thus subject to same inaccuracy.

array CountTotal=panel.CountTotal();// - The number of panel members including disabled.

array GetGroupings=panel.GetGroupings();// - The groping values. E.g. week 32 in 2014 is returned as {32,2014}. Grouping by year is returned as {2014,2014}

string ToString=panel.ToString();// - The string representation of the object.
//CountReadInvitation & CountReadInvitationSum
array a = DateTime_getByYMD(2017,5,29); 
array b = DateTime_getByYMD(2017,5,31);
PanelStatistics ps = new PanelStatistics({12784},{12767},13900,a,b,1,0);
print(ps.CountReadInvitation());//{3}
print(ps.CountReadInvitationSum());//{9}

Ta.png