Difference between revisions of "PanelStatistics class"

From Catglobe Wiki
Jump to: navigation, search
Line 15: Line 15:
 
{{CGscriptMethods_Template|ReturnType=array|Name=CountTotal|Description=The number of panel members excluding disabled and deleted.}}
 
{{CGscriptMethods_Template|ReturnType=array|Name=CountTotal|Description=The number of panel members excluding disabled and deleted.}}
 
{{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=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=number|Name=TotalAvailablePoints|Description=Sum of points panel members has available at the 'to' date}}
 +
{{CGscriptMethods_Template|ReturnType=number|Name=TotalEarnedPoints|Description=Sum of points panel members earned}}
 +
{{CGscriptMethods_Template|ReturnType=number|Name=TotalUsedPoints|Description=Sum of points panel members used}}
 +
{{CGscriptMethods_Template|ReturnType=array|Name=CountEarnedPoints|Description=Number of points panel members earned}}
 +
{{CGscriptMethods_Template|ReturnType=Dictionary|Name=TotalEarnedPointsBySurvey|Description=Dictionary of questionnaire id and number of points panel members earned for that questionnaire}}
 +
{{CGscriptMethods_Template|ReturnType=array|Name=CountUsedPoints|Description=Number of points panel members used. Included points spent on shopping and subtracted for going back in a questionnaire.}}
 +
{{CGscriptMethods_Template|ReturnType=array|Name=CountUsedPointsOnOrders|Description=Number of points panel members used for shopping.}}
 
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
 
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
 
|Properties=
 
|Properties=

Revision as of 12:40, 16 March 2016

PanelStatistics



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

Constructors

  • (array questionnaireResourceTemplateRId "the questionnaires examined to these types (required)", array bulkmailIds "The count of mails sent to those sent from these bulkmails (required)", number groupRId "Resource id of group containing all panel members", array from "From date", array to "To date", number groupBy "Return results in these groupings. 1=Week, 2=Month, 3=Quarter, 4=Year") - Create new statistics

Methods

  • array CountActive() - Number of panel members that started a survey.
  • array CountCompletedInterviews() - Number of panel members that completed a survey.
  • array CountCreated() - Number of panel members that was created.
  • array CountDisabled() - Number of panel members that was disabled.
  • array CountGotInvitation() - Number of panel members that received an invitation.
  • 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 CountTotal() - The number of panel members excluding disabled and deleted.
  • array GetGroupings() - The groping values. E.g. week 32 in 2014 is returned as {32, 2014}. Grouping by year is returned as {2014, 2014}.
  • number TotalAvailablePoints() - Sum of points panel members has available at the 'to' date
  • number TotalEarnedPoints() - Sum of points panel members earned
  • number TotalUsedPoints() - Sum of points panel members used
  • array CountEarnedPoints() - Number of points panel members earned
  • Dictionary TotalEarnedPointsBySurvey() - Dictionary of questionnaire id and number of points panel members earned for that questionnaire
  • 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.
  • 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

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.