Enables scripted content fragments to use reporting Urls
- ActiveContent
- ActiveGroups
- ActiveMembers
- BlogDetail
- BlogsSummary
- CalendarDetail
- CalendarsSummary
- CommunityHealthSummary
- Content
- ForumDetail
- ForumsSummary
- GalleriesSummary
- GalleryDetail
- GroupDetail
- GroupsSummary
- IdeationDetail
- IdeationsSummary
- Interactions
- KnowledgeCollectionDetail
- KnowledgeCollectionsSummary
- NewGroups
- NewMembers
- Participation
- ViewedContent
- WikiDetail
- WikisSummary
Methods
ActiveContent
Active Content Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.ActiveContent("%{ applicationIds = $applicationIdsArg, datePeriod = $datePeriodArg, endDate = $endDateArg, groupIds = $groupIdsArg, includeAnonymous = $includeAnonymousArg, includeApplications = $includeApplicationsArg, includeGroups = $includeGroupsArg, includeRoles = $includeRolesArg, includeSubGroups = $includeSubGroupsArg, includeUsers = $includeUsersArg, roleIds = $roleIdsArg, startDate = $startDateArg, userIds = $userIdsArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.ActiveContent({ applicationIds: applicationIdsArg, datePeriod: datePeriodArg, endDate: endDateArg, groupIds: groupIdsArg, includeAnonymous: includeAnonymousArg, includeApplications: includeApplicationsArg, includeGroups: includeGroupsArg, includeRoles: includeRolesArg, includeSubGroups: includeSubGroupsArg, includeUsers: includeUsersArg, roleIds: roleIdsArg, startDate: startDateArg, userIds: userIdsArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
applicationIds | String | Comma delimited list of application Ids (Guid). Only one of groupIds or applicationIds may be specified, if both are provided, groupIds will be used. | Optional | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
groupIds | String | Comma delimited list of group Ids (Guid). Only one of groupIds or applicationIds may be specified, if both are provided, groupIds will be used. | Optional | ||
includeAnonymous | Boolean | Should anonymous users be included in report. | Optional | True | |
includeApplications | String | Include or Exclude the applications from applicationIds parameter | Optional | include | exclude, include |
includeGroups | String | Include or Exclude the groups from groupIds parameter | Optional | include | exclude, include |
includeRoles | String | Include or Exclude the roles from roleIds parameter | Optional | include | exclude, include |
includeSubGroups | Boolean | Should SubGroups of the GroupIds provided be included. | Optional | True | |
includeUsers | String | Include or Exclude the users from userIds parameter | Optional | include | exclude, include |
roleIds | String | Comma delimited list of role Ids (integer). This option is only available for users with Site Reporting permission. | Optional | ||
startDate | DateTime | Start Date | Optional | ||
userIds | String | Comma delimited list of userIds (integer) | Optional |
Returns
String
ActiveGroups
Active Groups Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.ActiveGroups("%{ datePeriod = $datePeriodArg, endDate = $endDateArg, startDate = $startDateArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.ActiveGroups({ datePeriod: datePeriodArg, endDate: endDateArg, startDate: startDateArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
startDate | DateTime | Start Date | Optional |
Returns
String
ActiveMembers
Active Members Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.ActiveMembers("%{ applicationIds = $applicationIdsArg, datePeriod = $datePeriodArg, endDate = $endDateArg, groupIds = $groupIdsArg, includeAnonymous = $includeAnonymousArg, includeApplications = $includeApplicationsArg, includeGroups = $includeGroupsArg, includeRoles = $includeRolesArg, includeSubGroups = $includeSubGroupsArg, includeUsers = $includeUsersArg, roleIds = $roleIdsArg, startDate = $startDateArg, userIds = $userIdsArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.ActiveMembers({ applicationIds: applicationIdsArg, datePeriod: datePeriodArg, endDate: endDateArg, groupIds: groupIdsArg, includeAnonymous: includeAnonymousArg, includeApplications: includeApplicationsArg, includeGroups: includeGroupsArg, includeRoles: includeRolesArg, includeSubGroups: includeSubGroupsArg, includeUsers: includeUsersArg, roleIds: roleIdsArg, startDate: startDateArg, userIds: userIdsArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
applicationIds | String | Comma delimited list of application Ids (Guid). Only one of groupIds or applicationIds may be specified, if both are provided, groupIds will be used. | Optional | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
groupIds | String | Comma delimited list of group Ids (Guid). Only one of groupIds or applicationIds may be specified, if both are provided, groupIds will be used. | Optional | ||
includeAnonymous | Boolean | Should anonymous users be included in report. | Optional | True | |
includeApplications | String | Include or Exclude the applications from applicationIds parameter | Optional | include | exclude, include |
includeGroups | String | Include or Exclude the groups from groupIds parameter | Optional | include | exclude, include |
includeRoles | String | Include or Exclude the roles from roleIds parameter | Optional | include | exclude, include |
includeSubGroups | Boolean | Should SubGroups of the GroupIds provided be included. | Optional | True | |
includeUsers | String | Include or Exclude the users from userIds parameter | Optional | include | exclude, include |
roleIds | String | Comma delimited list of role Ids (integer). This option is only available for users with Site Reporting permission. | Optional | ||
startDate | DateTime | Start Date | Optional | ||
userIds | String | Comma delimited list of userIds (integer) | Optional |
Returns
String
BlogDetail
Blog Detail Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.BlogDetail("%{ applicationId = $applicationIdArg, datePeriod = $datePeriodArg, endDate = $endDateArg, startDate = $startDateArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.BlogDetail({ applicationId: applicationIdArg, datePeriod: datePeriodArg, endDate: endDateArg, startDate: startDateArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
applicationId | Guid | Unique Identifier for Blog Application | Optional | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
startDate | DateTime | Start Date | Optional |
Returns
String
BlogsSummary
Blogs Summary Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.BlogsSummary())
JavaScript
var stringResponse = core_v1_reportingUrls.BlogsSummary();
Returns
String
CalendarDetail
Calendar Detail Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.CalendarDetail("%{ applicationId = $applicationIdArg, datePeriod = $datePeriodArg, endDate = $endDateArg, startDate = $startDateArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.CalendarDetail({ applicationId: applicationIdArg, datePeriod: datePeriodArg, endDate: endDateArg, startDate: startDateArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
applicationId | Guid | Unique Identifier for Calendar Application | Optional | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
startDate | DateTime | Start Date | Optional |
Returns
String
CalendarsSummary
Calendars Summary Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.CalendarsSummary())
JavaScript
var stringResponse = core_v1_reportingUrls.CalendarsSummary();
Returns
String
CommunityHealthSummary
Community Health Summary Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.CommunityHealthSummary("%{ DatePeriod = $datePeriodArg, EndDate = $endDateArg, StartDate = $startDateArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.CommunityHealthSummary({ DatePeriod: datePeriodArg, EndDate: endDateArg, StartDate: startDateArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
DatePeriod | String | Date Period | Optional | day, month, week, year | |
EndDate | Int32 | End Date | Optional | ||
StartDate | Int32 | Start Date | Optional |
Returns
String
Content
Content Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.Content("%{ applicationIds = $applicationIdsArg, datePeriod = $datePeriodArg, endDate = $endDateArg, groupIds = $groupIdsArg, includeAnonymous = $includeAnonymousArg, includeApplications = $includeApplicationsArg, includeGroups = $includeGroupsArg, includeRoles = $includeRolesArg, includeSubGroups = $includeSubGroupsArg, includeUsers = $includeUsersArg, roleIds = $roleIdsArg, startDate = $startDateArg, userIds = $userIdsArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.Content({ applicationIds: applicationIdsArg, datePeriod: datePeriodArg, endDate: endDateArg, groupIds: groupIdsArg, includeAnonymous: includeAnonymousArg, includeApplications: includeApplicationsArg, includeGroups: includeGroupsArg, includeRoles: includeRolesArg, includeSubGroups: includeSubGroupsArg, includeUsers: includeUsersArg, roleIds: roleIdsArg, startDate: startDateArg, userIds: userIdsArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
applicationIds | String | Comma delimited list of application Ids (Guid). Only one of groupIds or applicationIds may be specified, if both are provided, groupIds will be used. | Optional | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
groupIds | String | Comma delimited list of group Ids (Guid). Only one of groupIds or applicationIds may be specified, if both are provided, groupIds will be used. | Optional | ||
includeAnonymous | Boolean | Should anonymous users be included in report. | Optional | True | |
includeApplications | String | Include or Exclude the applications from applicationIds parameter | Optional | include | exclude, include |
includeGroups | String | Include or Exclude the groups from groupIds parameter | Optional | include | exclude, include |
includeRoles | String | Include or Exclude the roles from roleIds parameter | Optional | include | exclude, include |
includeSubGroups | Boolean | Should SubGroups of the GroupIds provided be included. | Optional | True | |
includeUsers | String | Include or Exclude the users from userIds parameter | Optional | include | exclude, include |
roleIds | String | Comma delimited list of role Ids (integer). This option is only available for users with Site Reporting permission. | Optional | ||
startDate | DateTime | Start Date | Optional | ||
userIds | String | Comma delimited list of userIds (integer) | Optional |
Returns
String
ForumDetail
Forum Detail Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.ForumDetail("%{ applicationId = $applicationIdArg, datePeriod = $datePeriodArg, endDate = $endDateArg, startDate = $startDateArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.ForumDetail({ applicationId: applicationIdArg, datePeriod: datePeriodArg, endDate: endDateArg, startDate: startDateArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
applicationId | Guid | Unique Identifier for Forum Application | Optional | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
startDate | DateTime | Start Date | Optional |
Returns
String
ForumsSummary
Forums Summary Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.ForumsSummary())
JavaScript
var stringResponse = core_v1_reportingUrls.ForumsSummary();
Returns
String
GalleriesSummary
Galleries Summary Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.GalleriesSummary())
JavaScript
var stringResponse = core_v1_reportingUrls.GalleriesSummary();
Returns
String
GalleryDetail
Gallery Detail Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.GalleryDetail("%{ applicationId = $applicationIdArg, datePeriod = $datePeriodArg, endDate = $endDateArg, startDate = $startDateArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.GalleryDetail({ applicationId: applicationIdArg, datePeriod: datePeriodArg, endDate: endDateArg, startDate: startDateArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
applicationId | Guid | Unique Identifier for Gallery Application | Optional | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
startDate | DateTime | Start Date | Optional |
Returns
String
GroupDetail
Group Detail Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.GroupDetail("%{ datePeriod = $datePeriodArg, endDate = $endDateArg, groupId = $groupIdArg, startDate = $startDateArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.GroupDetail({ datePeriod: datePeriodArg, endDate: endDateArg, groupId: groupIdArg, startDate: startDateArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
groupId | Guid | Unique Identifier for a Group | Optional | ||
startDate | DateTime | Start Date | Optional |
Returns
String
GroupsSummary
Groups Summary Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.GroupsSummary())
JavaScript
var stringResponse = core_v1_reportingUrls.GroupsSummary();
Returns
String
IdeationDetail
Ideation Detail Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.IdeationDetail("%{ applicationId = $applicationIdArg, datePeriod = $datePeriodArg, endDate = $endDateArg, startDate = $startDateArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.IdeationDetail({ applicationId: applicationIdArg, datePeriod: datePeriodArg, endDate: endDateArg, startDate: startDateArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
applicationId | Guid | Unique Identifier for Ideation Application | Optional | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
startDate | DateTime | Start Date | Optional |
Returns
String
IdeationsSummary
Ideations Summary Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.IdeationsSummary())
JavaScript
var stringResponse = core_v1_reportingUrls.IdeationsSummary();
Returns
String
Interactions
Interactions Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.Interactions("%{ applicationIds = $applicationIdsArg, datePeriod = $datePeriodArg, endDate = $endDateArg, groupIds = $groupIdsArg, includeAnonymous = $includeAnonymousArg, includeApplications = $includeApplicationsArg, includeGroups = $includeGroupsArg, includeRoles = $includeRolesArg, includeSubGroups = $includeSubGroupsArg, includeUsers = $includeUsersArg, roleIds = $roleIdsArg, startDate = $startDateArg, userIds = $userIdsArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.Interactions({ applicationIds: applicationIdsArg, datePeriod: datePeriodArg, endDate: endDateArg, groupIds: groupIdsArg, includeAnonymous: includeAnonymousArg, includeApplications: includeApplicationsArg, includeGroups: includeGroupsArg, includeRoles: includeRolesArg, includeSubGroups: includeSubGroupsArg, includeUsers: includeUsersArg, roleIds: roleIdsArg, startDate: startDateArg, userIds: userIdsArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
applicationIds | String | Comma delimited list of application Ids (Guid). Only one of groupIds or applicationIds may be specified, if both are provided, groupIds will be used. | Optional | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
groupIds | String | Comma delimited list of group Ids (Guid). Only one of groupIds or applicationIds may be specified, if both are provided, groupIds will be used. | Optional | ||
includeAnonymous | Boolean | Should anonymous users be included in report. | Optional | True | |
includeApplications | String | Include or Exclude the applications from applicationIds parameter | Optional | include | exclude, include |
includeGroups | String | Include or Exclude the groups from groupIds parameter | Optional | include | exclude, include |
includeRoles | String | Include or Exclude the roles from roleIds parameter | Optional | include | exclude, include |
includeSubGroups | Boolean | Should SubGroups of the GroupIds provided be included. | Optional | True | |
includeUsers | String | Include or Exclude the users from userIds parameter | Optional | include | exclude, include |
roleIds | String | Comma delimited list of role Ids (integer). This option is only available for users with Site Reporting permission. | Optional | ||
startDate | DateTime | Start Date | Optional | ||
userIds | String | Comma delimited list of userIds (integer) | Optional |
Returns
String
KnowledgeCollectionDetail
Knowledge Collection Detail Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.KnowledgeCollectionDetail("%{ applicationId = $applicationIdArg, datePeriod = $datePeriodArg, endDate = $endDateArg, startDate = $startDateArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.KnowledgeCollectionDetail({ applicationId: applicationIdArg, datePeriod: datePeriodArg, endDate: endDateArg, startDate: startDateArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
applicationId | Guid | Unique Identifier for Knowledge Collection Application | Optional | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
startDate | DateTime | Start Date | Optional |
Returns
String
KnowledgeCollectionsSummary
Knowledge Collections Summary Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.KnowledgeCollectionsSummary())
JavaScript
var stringResponse = core_v1_reportingUrls.KnowledgeCollectionsSummary();
Returns
String
NewGroups
New Groups Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.NewGroups("%{ datePeriod = $datePeriodArg, endDate = $endDateArg, startDate = $startDateArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.NewGroups({ datePeriod: datePeriodArg, endDate: endDateArg, startDate: startDateArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
startDate | DateTime | Start Date | Optional |
Returns
String
NewMembers
New Members Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.NewMembers("%{ applicationIds = $applicationIdsArg, datePeriod = $datePeriodArg, endDate = $endDateArg, groupIds = $groupIdsArg, includeAnonymous = $includeAnonymousArg, includeApplications = $includeApplicationsArg, includeGroups = $includeGroupsArg, includeRoles = $includeRolesArg, includeSubGroups = $includeSubGroupsArg, includeUsers = $includeUsersArg, roleIds = $roleIdsArg, startDate = $startDateArg, userIds = $userIdsArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.NewMembers({ applicationIds: applicationIdsArg, datePeriod: datePeriodArg, endDate: endDateArg, groupIds: groupIdsArg, includeAnonymous: includeAnonymousArg, includeApplications: includeApplicationsArg, includeGroups: includeGroupsArg, includeRoles: includeRolesArg, includeSubGroups: includeSubGroupsArg, includeUsers: includeUsersArg, roleIds: roleIdsArg, startDate: startDateArg, userIds: userIdsArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
applicationIds | String | Comma delimited list of application Ids (Guid). Only one of groupIds or applicationIds may be specified, if both are provided, groupIds will be used. | Optional | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
groupIds | String | Comma delimited list of group Ids (Guid). Only one of groupIds or applicationIds may be specified, if both are provided, groupIds will be used. | Optional | ||
includeAnonymous | Boolean | Should anonymous users be included in report. | Optional | True | |
includeApplications | String | Include or Exclude the applications from applicationIds parameter | Optional | include | exclude, include |
includeGroups | String | Include or Exclude the groups from groupIds parameter | Optional | include | exclude, include |
includeRoles | String | Include or Exclude the roles from roleIds parameter | Optional | include | exclude, include |
includeSubGroups | Boolean | Should SubGroups of the GroupIds provided be included. | Optional | True | |
includeUsers | String | Include or Exclude the users from userIds parameter | Optional | include | exclude, include |
roleIds | String | Comma delimited list of role Ids (integer). This option is only available for users with Site Reporting permission. | Optional | ||
startDate | DateTime | Start Date | Optional | ||
userIds | String | Comma delimited list of userIds (integer) | Optional |
Returns
String
Participation
Participation Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.Participation("%{ applicationIds = $applicationIdsArg, datePeriod = $datePeriodArg, endDate = $endDateArg, groupIds = $groupIdsArg, includeAnonymous = $includeAnonymousArg, includeApplications = $includeApplicationsArg, includeGroups = $includeGroupsArg, includeRoles = $includeRolesArg, includeSubGroups = $includeSubGroupsArg, includeUsers = $includeUsersArg, roleIds = $roleIdsArg, startDate = $startDateArg, userIds = $userIdsArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.Participation({ applicationIds: applicationIdsArg, datePeriod: datePeriodArg, endDate: endDateArg, groupIds: groupIdsArg, includeAnonymous: includeAnonymousArg, includeApplications: includeApplicationsArg, includeGroups: includeGroupsArg, includeRoles: includeRolesArg, includeSubGroups: includeSubGroupsArg, includeUsers: includeUsersArg, roleIds: roleIdsArg, startDate: startDateArg, userIds: userIdsArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
applicationIds | String | Comma delimited list of application Ids (Guid). Only one of groupIds or applicationIds may be specified, if both are provided, groupIds will be used. | Optional | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
groupIds | String | Comma delimited list of group Ids (Guid). Only one of groupIds or applicationIds may be specified, if both are provided, groupIds will be used. | Optional | ||
includeAnonymous | Boolean | Should anonymous users be included in report. | Optional | True | |
includeApplications | String | Include or Exclude the applications from applicationIds parameter | Optional | include | exclude, include |
includeGroups | String | Include or Exclude the groups from groupIds parameter | Optional | include | exclude, include |
includeRoles | String | Include or Exclude the roles from roleIds parameter | Optional | include | exclude, include |
includeSubGroups | Boolean | Should SubGroups of the GroupIds provided be included. | Optional | True | |
includeUsers | String | Include or Exclude the users from userIds parameter | Optional | include | exclude, include |
roleIds | String | Comma delimited list of role Ids (integer). This option is only available for users with Site Reporting permission. | Optional | ||
startDate | DateTime | Start Date | Optional | ||
userIds | String | Comma delimited list of userIds (integer) | Optional |
Returns
String
ViewedContent
VIewed Content Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.ViewedContent("%{ applicationIds = $applicationIdsArg, datePeriod = $datePeriodArg, endDate = $endDateArg, groupIds = $groupIdsArg, includeAnonymous = $includeAnonymousArg, includeApplications = $includeApplicationsArg, includeGroups = $includeGroupsArg, includeRoles = $includeRolesArg, includeSubGroups = $includeSubGroupsArg, includeUsers = $includeUsersArg, roleIds = $roleIdsArg, startDate = $startDateArg, userIds = $userIdsArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.ViewedContent({ applicationIds: applicationIdsArg, datePeriod: datePeriodArg, endDate: endDateArg, groupIds: groupIdsArg, includeAnonymous: includeAnonymousArg, includeApplications: includeApplicationsArg, includeGroups: includeGroupsArg, includeRoles: includeRolesArg, includeSubGroups: includeSubGroupsArg, includeUsers: includeUsersArg, roleIds: roleIdsArg, startDate: startDateArg, userIds: userIdsArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
applicationIds | String | Comma delimited list of application Ids (Guid). Only one of groupIds or applicationIds may be specified, if both are provided, groupIds will be used. | Optional | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
groupIds | String | Comma delimited list of group Ids (Guid). Only one of groupIds or applicationIds may be specified, if both are provided, groupIds will be used. | Optional | ||
includeAnonymous | Boolean | Should anonymous users be included in report. | Optional | True | |
includeApplications | String | Include or Exclude the applications from applicationIds parameter | Optional | include | exclude, include |
includeGroups | String | Include or Exclude the groups from groupIds parameter | Optional | include | exclude, include |
includeRoles | String | Include or Exclude the roles from roleIds parameter | Optional | include | exclude, include |
includeSubGroups | Boolean | Should SubGroups of the GroupIds provided be included. | Optional | True | |
includeUsers | String | Include or Exclude the users from userIds parameter | Optional | include | exclude, include |
roleIds | String | Comma delimited list of role Ids (integer). This option is only available for users with Site Reporting permission. | Optional | ||
startDate | DateTime | Start Date | Optional | ||
userIds | String | Comma delimited list of userIds (integer) | Optional |
Returns
String
WikiDetail
Wiki Detail Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.WikiDetail("%{ applicationId = $applicationIdArg, datePeriod = $datePeriodArg, endDate = $endDateArg, startDate = $startDateArg }"))
JavaScript
var stringResponse = core_v1_reportingUrls.WikiDetail({ applicationId: applicationIdArg, datePeriod: datePeriodArg, endDate: endDateArg, startDate: startDateArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
applicationId | Guid | Unique Identifier for Wiki Application | Optional | ||
datePeriod | String | Date Period | Optional | day, month, week, year | |
endDate | DateTime | End Date | Optional | ||
startDate | DateTime | Start Date | Optional |
Returns
String
WikisSummary
Wikis Summary Report Url
Velocity
#set($stringResponse = $core_v1_reportingUrls.WikisSummary())
JavaScript
var stringResponse = core_v1_reportingUrls.WikisSummary();
Returns
String