Difference between revisions of "PanelStatistics class"
| Line 4: | Line 4: | ||
|Constructors= | |Constructors= | ||
{{CGscriptConstructors_Template|Parameters= | {{CGscriptConstructors_Template|Parameters= | ||
| − | {{CGscriptParameters_Template|Type=array|Name=questionnaireResourceTemplateRId|Description= | + | {{CGscriptParameters_Template|Type=array|Name=questionnaireResourceTemplateRId|Description=the questionnaires examined to these types (required)|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=bulkmailIds|Description=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}} |
|Description=Create new statistics}} | |Description=Create new statistics}} | ||
|Methods= | |Methods= | ||
Revision as of 10:03, 13 April 2015
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.
- number CountTotal() - The number of panel members including disabled.
- array 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() - 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.
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.
