Learner Activity

post

https://api.percipio.com/content-discovery/v1/organizations/{orgId}/report-requests/learning-activity

Learner activity report provides learning activity for learners and includes details such as course id and title, percent complete, completion date, etc. This API call returns a report handle used to retrieve the learning activity report via the report request API. The report data can be customized and filtered based on the parameters mentioned below. If the response is not successful, the appropriate error response returns.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

orgId

uuid

required

Organization UUID

Body Params

The configuration to create request handle is supplied in the request body

start

date-time

Start date for events retrieval

end

date-time

End date for events retrieval

timeFrame

string

enum

To calculate the start/end date dynamically based on timeframe and when the report is submitted date. [User can submit an absolute date range (start/end date) or a relative date range (timeframe) but never both]

Allowed:

audience

string

Defaults to ALL

Audience filter, defaults to all audience

locale

string

The field to use for specifying language. Will default to all when not specified. example format 'en-US' or 'fr-FR' or 'de-DE' etc.

contentType

string

Content types filter, comma delimited and default to all content types

template

string

enum

XML template for LMS based on learning report export. This parameter is required for XML formatType. Please Note- If template is present then the value of formatType should be XML only.

Allowed:

plugin

string

A highly customized LMS specific LAR export that supports minimal configuration. Values are case-sensitive Please Note- Transform should correspond to the selected plugin. If transformName is not provided then the transform with the name similar to that of the plugin will be used as per preferential logic.

transformName

string

Jsonata transform name to transform Percipio fields to client sepecific fields, either transform name or mapping should be given but not both.

mapping

string

Jsonata transform mapping to transform Percipio fields to client sepecific fields, either transform name or mapping should be given but not both.

csvPreferences

object

csv preferences to generate csv file for the transformed output

sort

object

The field to use for sorting and which order to sort in, if sort is not included the results will be returned descending by lastAccessDate

status

string

enum

Learner activity status filter, defaults to all status type

sftpId

uuid

SFTP Id associated with OrgId

isFileRequiredInSftp

boolean

Defaults to true

Generated files are required to deliver in the respected sftp location. Default value is true.

zip

boolean

Defaults to false

Generate the reports in zip file format. Default value is false.

encrypt

boolean

Defaults to false

Generate the report file as PGP encrypted file. Default value is false.

isPgpFileExtnNotReqrd

boolean

Defaults to false

If the file that need to be ecncrypted should not include a extension of .pgp at the end of the file name, the value should be set to true. If user sets the value as false or doesn't include the flag a .pgp extension will be appended at the end of file name.

formatType

string

enum

Defaults to JSON

Format Type, defaults to JSON, the value is extracted from Accept attribute in header

Allowed:

fileMask

string

Absolute or masked pattern for the generated report file. Example file masks - fileName_{DD}{MM}{YYYY}, fileName_{ORG_ID}

folderName

string

custom folder under sftp reports wherein the generated report file is to be placed.

includeMillisInFilename

boolean

Defaults to false

Generate files with unix based timestamp. Example - fileName.csv.1561642446608

Responses

400

Bad Request

401

Unauthorized

422

Unprocessable Entity

500

Unexpected error

200Ok

202Accepted