ePortfolio Template Usage Methods

Summary

The Digication API can be used by schools to obtain periodic usage statistics for the ePortfolio templates they have enabled for their users.  The available fields include counts of individual actions taken by each user, and tracking user activity over time can be a powerful tool for studying how the use of ePortfolios in the classroom impacts student participation and progress.

School wide templates can be configured by going to Administration > ePortfolios > Templates.  Contact support@digication.com to obtain the unique identifiers for the templates you would like to begin tracking.

The basic protocol and format of the Digication API are documented here: https://support.digication.com/entries/20887273-API-Basics

Available Methods

ePortfolio Template Methods:

Method: portfolio.stats_by_template - List users who have created portfolios from a specific template, and information about the user's engagement.

Parameters:
templateid - the id of the template

Returns:
result[n].otherid - the syncid of the user
result[n].portfolios - the number of portfolios this user created from the template specified
result[n].hits - the total number of hits for the user's portfolios
result[n].comments - the total number of comments received on the user's portfolios
result[n].pages - the total number of pages in the user's portfolios
result[n].modules - the total number of modules in the user's portfolios
result[n].files - the total number of files uploaded by the user
result[n].logins - the total number of times the user has logged in
result[n].pagescreated - the total number of pages created by the user (in any portfolios)

Method: portfolio.settings_by_template - List users who have created portfolios from a specific template, and information about those portfolios.

Parameters:
templateid - the id of the template

Returns:
result[n].otherid - the syncid of the user
result[n].portfolios - the number of portfolios this user created from the template specified
result[n].customcss - the number of portfolios that have custom css
result[n].shared - the number of portfolios that have more than one editor
result[n].public - the number of portfolios that are public
result[n].schoolprivate - the number of portfolios that are private to the school
result[n].private - the number of portfolios that are private

Method: portfolio.modules_by_template - List users who have created portfolios from a specific template, and information about the modules within those portfolios.

Parameters:
templateid - the id of the template

Returns:
result[n].otherid - the syncid of the user
result[n].portfolios - the number of portfolios this user created from the template specified
result[n].modules[type] - the number of modules of this type in the user's portfolios
result[n].galleryslides - the number of slides in galleries in the user's portfolios

Course Methods:

Method: submissions.stats_by_course - List users in a specific course and information about the user's engagement.

Parameters:
otherid - the syncid of the course

Returns:
result[n].otherid - the syncid of the user
result[n].submitted - the number of completed evidence steps in the course for this user
result[n].text - the number of completed evidence steps with text for this user
result[n].files - the number of files attached to completed evidence steps for this user
result[n].portfolios - the number of portfolios attached to completed evidence steps for this user

Method: course.listusers - List users in a specific course and information about the users.

Parameters:
otherid - the syncid of the course

Returns:
result.users[userid].userid - the internal id of the user
result.users[userid].firstname - the firstname of the user
result.users[userid].lastname - the lastname of the user
result.users[userid].username - the username of the user
result.users[userid].otherid - the syncid of the user
result.users[userid].notify_email - the email of the user
result.users[userid].facultyf - 0 or 1 if the user is faculty