Story Logs
Parameters
All parameters are optional and if none are provided all stories, users and groups will be called.
Key | Type |
app | String (ID or name of app) |
story | String (ID or name of story) |
groups | Array String (name of group) |
users | Array String (name or email) |
Story Limit
This endpoint retrieves only 1 story. If you need to retrieve all story data use the logs/user-story-logs
endpoint instead.
Examples
Fetch logs for specific groups
The example below retrieves all users and stories for a given array of groups.
Fetch logs for a specific story
The example below retrieves all users for a given story.
Fetch logs for specific users
The example below retrieves logs users for a given array of emails.
Full Example
The example below retrieves logs for specific users & stories in certain groups.
Success Response
The response returns a list of story
+ logs
items.
Story + Logs Item
Key | Type |
story | Object |
story.ID | String |
story.name | String |
story.type | Enum (assessment, story, survey, scorm) |
story.app | Object (the app the story is published to) |
logs | Array of Log Items |
Log Items
Please Note: Only assessment or stories that have assessment activities will have a passed and score parameter. Non-scoring stories such as surveys will not have these parameters.
Key | Type |
firstname | String |
lastname | String |
String | |
telephone | String |
country | String |
city | String |
groups | Array String (Assigned groups) |
status | Object |
status.complete | Bool (If the story has been completed) |
status.duration | Int (Total time spent in seconds) |
status.attempts | Int (Total attempts) |
status.started | String (Time when first attempt was started) |
status.updated | String (Timestamp when the last attempt was updated.) |
SCORING STORY ONLY | |
status.score | Float. Percentage scored |
status.passed | Bool. If the pass mark was achieved. |
Last updated