corporateacademy-initiatives-dashboard

Methods

(static) countAllItemsOfUserAnalytics(description, startDate, endDate, userId, token) → {number}

Retrieve all items (course and online items) where the user have at least one completion (for online items related to a course, will be retrieved only 1 row for the engangement: EVENT_COURSE_PASSED, ignoring EVENT_ITEM_CONSUMED)

Parameters:
Name Type Description
description string

Optional by the action: Filter the list of courses by description parameter

startDate Date

Optional by the action: If filterByDateRange is true specify the startDate to filter

endDate Date

Optional by the action: If filterByDateRange is true specify the endDate to filter

userId string

Optional by the action: The userId to retrieve the data

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/count-all-items-of-user-analytics
Returns:

The engagement count

Type
number

(static) countDashboardSuggestedItems(fromDate, toDate, fromRecord, numRecords, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {Array.<SuggestedItem>}

Retrieve the suggested items analytics for the dashboard

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

fromRecord number

Required by the action: The number of the first record to load (exclusive - 0 to start from the first)

numRecords number

Required by the action: The number of records to load

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/count-dashboard-suggested-items
Returns:

The data to display

Type
Array.<SuggestedItem>

(static) countItemSuggesterUsers(fromDate, toDate, fromRecord, numRecords, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {number}

Retrieve the users who suggested the specified item

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

fromRecord number

Required by the action: The number of the first record to load (exclusive - 0 to start from the first)

numRecords number

Required by the action: The number of records to load

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/count-item-suggester-users
Returns:

The data to display

Type
number

(static) courseCreditsAnalytics(fromDate, toDate, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {Array.<User>}

Retrieve the training hours grouped by time period(week or date)

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/course-credits-analytics
Returns:

The data to display

Type
Array.<User>

(static) distinctTrainedUsersCount(fromDate, toDate, fromRecord, numRecords, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, textFilter, token) → {number}

Retrieve distinct users count that consumed objects

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

fromRecord number

Required by the action: The number of the first record to load (exclusive - 0 to start from the first)

numRecords number

Required by the action: The number of records to load

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

textFilter string

Optional: Text used to filter on the users

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/distinct-trained-users-count
Returns:

The data to display

Type
number

(static) getAllItemsOfUserAnalytics(description, startDate, endDate, userId, fromRecord, numRecords, allData, token) → {CustomCourseAndDate}

Retrieve all items (course and online items) where the user have at least one completion (for online items related to a course, will be retrieved only 1 row for the engangement: EVENT_COURSE_PASSED, ignoring EVENT_ITEM_CONSUMED)

Parameters:
Name Type Description
description string

Optional by the action: Filter the list of courses by description parameter

startDate Date

Optional by the action: If filterByDateRange is true specify the startDate to filter

endDate Date

Optional by the action: If filterByDateRange is true specify the endDate to filter

userId string

Optional by the action: The userId to retrieve the data

fromRecord number

Optional by the action: fromRecord

numRecords number

Optional by the action: numRecords

allData boolean

Optional for the action: If passed with true value, all data will be returned (fromRecord and numRecords are not required)

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/get-all-items-of-user-analytics
Returns:

the required data

Type
CustomCourseAndDate

(static) getConsumedItemUsers(itemId, fromDate, toDate, fromRecord, numRecords, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {Array.<User>}

Retrieve the users of a consumed item

Parameters:
Name Type Description
itemId string

Required: the consumed item id

fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

fromRecord number

Required by the action: The number of the first record to load (exclusive - 0 to start from the first)

numRecords number

Required by the action: The number of records to load

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/get-consumed-item-users/:fromRecord/:numRecords
Returns:

The data to display

Type
Array.<User>

(static) getCourseInvitesAnalytics(fromDate, toDate, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {CourseInviteAnalytics}

Retrieve the number of accepted and refused course invites

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/get-course-invites-analytics
Returns:

The data to display

Type
CourseInviteAnalytics

(static) getCourseInvitesUsers(fromDate, toDate, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, textFilter, eventName, fromRecord, numRecords, token)

Retrieve the users which accepted and refused course invites

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

textFilter string

Optional: Text used to filter the users

eventName string

Optional: Event name to retrieve

fromRecord number

Required: Result set's offset

numRecords number

Required: Number of records to retrieve

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/get-course-invites-users/:fromRecord/:numRecords
Returns:

{{rows: CourseInviteUser[], totalRowsCount: number} The data to display

(static) getDashboardSuggestedItems(fromDate, toDate, fromRecord, numRecords, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {Array.<SuggestedItem>}

Retrieve the suggested items analytics for the dashboard

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

fromRecord number

Required by the action: The number of the first record to load (exclusive - 0 to start from the first)

numRecords number

Required by the action: The number of records to load

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/get-dashboard-suggested-items
Returns:

The data to display

Type
Array.<SuggestedItem>

(static) getDistinctNetworkCounters(fromDate, toDate, fromRecord, numRecords, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {number}

Retrieve distinct items count that consumed objects, distinct items count that certified object, distinct users count that consumed objects

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

fromRecord number

Required by the action: The number of the first record to load (exclusive - 0 to start from the first)

numRecords number

Required by the action: The number of records to load

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/get-distinct-network-counters
Returns:

The data to display

Type
number

(static) getItemSuggesterUsers(fromDate, toDate, fromRecord, numRecords, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {Array.<User>}

Retrieve the users who suggested the specified item

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

fromRecord number

Required by the action: The number of the first record to load (exclusive - 0 to start from the first)

numRecords number

Required by the action: The number of records to load

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/get-item-suggester-users
Returns:

The data to display

Type
Array.<User>

(static) getTrainedUsers(itemId, fromDate, toDate, fromRecord, numRecords, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {Array.<User>}

Retrieve the users who consumed at least an item or a course

Parameters:
Name Type Description
itemId string

Required: the consumed item id

fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

fromRecord number

Required by the action: The number of the first record to load (exclusive - 0 to start from the first)

numRecords number

Required by the action: The number of records to load

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/get-trained-users/:fromRecord/:numRecords
Returns:

The data to display

Type
Array.<User>

(static) listDistinctUsersField(distinctField, textFilter, includeNull, includeEmpty, skipSorting, fromRecord, numRecords, token) → {Array.<string>}

Retrieve all distinct values of a single field of all users

Parameters:
Name Type Description
distinctField string

Required by the action: The name of the filed to retrieve

textFilter string

Optional for the action: If present is used as a filter data

includeNull boolean

Optional for the action: If true a null values won't be excluded

includeEmpty boolean

Optional for the action: If true an empty values won't be excluded

skipSorting boolean

Optional for the action: If true data won't be sorted

fromRecord number

Optional for the action: The number of the first record to load (exclusive - 0 to start from the first)

numRecords number

Optional for the action: The number of records to load

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/list-distinct-users-field
Returns:

The list of distinct field values

Type
Array.<string>

(static) mostDetectedDevicesAnalytics(fromDate, toDate, fromRecord, numRecords, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {Array.<User>}

Retrieve the top active devices with their count

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

fromRecord number

Required by the action: The number of the first record to load (exclusive - 0 to start from the first)

numRecords number

Required by the action: The number of records to load

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/most-detected-devices-analytics/:fromRecord/:numRecords
Returns:

The data to display

Type
Array.<User>

(static) socialActivitiesAnalytics(fromDate, toDate, fromRecord, numRecords, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {UserActivitiesAnalytics}

Retrieve the numbers of suggested items, likes and logins

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

fromRecord number

Required by the action: The number of the first record to load (exclusive - 0 to start from the first)

numRecords number

Required by the action: The number of records to load

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/social-activities-analytics
Returns:

The data to display

Type
UserActivitiesAnalytics

(static) socialActivitiesAnalyticsByTimePeriod(fromDate, toDate, fromRecord, numRecords, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {Array.<UserActiviesAnalyticsByTimePeriod>}

Retrieve the numbers of items suggested, likes, dislikes and logins

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

fromRecord number

Required by the action: The number of the first record to load (exclusive - 0 to start from the first)

numRecords number

Required by the action: The number of records to load

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/social-activities-analytics-by-time-period
Returns:

The data to display

Type
Array.<UserActiviesAnalyticsByTimePeriod>

(static) socialActivitiesUsersData(fromDate, toDate, fromRecord, numRecords, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, eventName, textFilter, token) → {UsersActivities}

Retrieve the users with the data of the performed social activities (suggested items, likes and logins)

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

fromRecord number

Required by the action: The number of the first record to load (exclusive - 0 to start from the first)

numRecords number

Required by the action: The number of records to load

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

eventName string | Array.<string>

Optional: Retrieves only the given types of events

textFilter string

Optional: Filters the users serching for the given text

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/social-activities-users-data/:fromRecord/:numRecords
Returns:

The data to display

Type
UsersActivities

(static) suggestedItemsAnalytics(fromDate, toDate, fromRecord, numRecords, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {Object}

Retrieve the suggested items analytics for the dashboard

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

fromRecord number

Required by the action: The number of the first record to load (exclusive - 0 to start from the first)

numRecords number

Required by the action: The number of records to load

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/suggested-items-analytics
Returns:

The requested counters

Type
Object

(static) topActiveUsersAnalytics(fromDate, toDate, fromRecord, numRecords, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {Array.<User>}

Retrieve the top active users

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

fromRecord number

Required by the action: The number of the first record to load (exclusive - 0 to start from the first)

numRecords number

Required by the action: The number of records to load

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/top-active-users-analytics/:fromRecord/:numRecords
Returns:

The data to display

Type
Array.<User>

(static) topConsumedObjectsAnalytics(fromDate, toDate, fromRecord, numRecords, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {TopSkillsAnalytics}

Retrieve top consumed objects analytics data

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

fromRecord number

Required by the action: The number of the first record to load (exclusive - 0 to start from the first)

numRecords number

Required by the action: The number of records to load

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/top-consumed-objects-analytics/:fromRecord/:numRecords
Returns:

The data to display

Type
TopSkillsAnalytics

(static) trainingHoursAnalyticsByTimePeriod(fromDate, toDate, myDataOnly, gaiDataOnly, hrbpDataOnly, managerDataOnly, socDistacco, chief, token) → {Array.<User>}

Retrieve the training hours grouped by time period(week or date)

Parameters:
Name Type Description
fromDate Date

Optional for the action: The date range - start

toDate Date

Optional for the action: The date range - end

myDataOnly booelan

Optional: retrieve only user's personal data

gaiDataOnly booelan

Optional: retrieve only user's gai data

hrbpDataOnly booelan

Optional: retrieve only user's hrbp data

managerDataOnly booelan

Optional: retrieve only user's manager data

socDistacco string | Array.<string>

Optional

chief string | Array.<string>

Optional

token string

Required: the Authorization Bearer token passed in the Header of the request

Listens to Events:
  • event:HTTP GET /rest-api/corporateacademy-mediator/training-hours-analytics-by-time-period
Returns:

The data to display

Type
Array.<User>