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.

curl -X POST \
  v1/logs/story-logs \
  -H 'Authorization: Basic <Your Base64 Encoded Token>' \
  -d ' {
    "story" : "Story 1"
    "groups" : ["Group A","Group B",...etc]
  }'

Fetch logs for a specific story

The example below retrieves all users for a given story.

curl -X POST \
  v1/logs/story-logs \
  -H 'Authorization: Basic <Your Base64 Encoded Token>' \
  -d ' {
    "story" : "Story 1"
  }'

Fetch logs for specific users

The example below retrieves logs users for a given array of emails.

curl -X POST \
  logs/story-logs \
  -H 'Authorization: Basic <Your Base64 Encoded Token>' \
  -d ' {
    "story" : "Story 1"
    "users" : ["[e-mail]","Joe Soap",...etc]
  }'

Full Example

The example below retrieves logs for specific users & stories in certain groups.

curl -X POST \
  logs/story-logs \
  -H 'Authorization: Basic <Your Base64 Encoded Token>' \
  -d ' {
    "groups" : ["Group A"],
    "story"  : "Story 1",
    "emails" : ["[e-mail]","two@example",...etc]
  }'

Success Response

The response returns a list of story + logs items.

{
    "status": "success",
    "data": [
        {
            "story": {
                "ID": "EV72-RQZY-80AH",
                "name": "Story A",
                "type" : "assessment",
                "app": {
                    "ID": "io.falkor.demo",
                    "name": "Falkor",
                    "version": "2.5.0"
                }
            },
            "logs": [
                {
                    "firstname": "User",
                    "lastname": "One",
                    "email": "[e-mail]",
                    "telephone": "",
                    "country": "United Kingdom",
                    "city": "London",
                    "groups": [
                        "Group A",
                        "Group B"
                    ],
                    "status": {
                        "complete": true,
                        "score": 100,
                        "passed": true,
                        "duration": 19,
                        "attempts": 1,
                        "started": "2022-02-24T14:56:32+02:00",
                        "updated": "2022-02-24T14:56:53+02:00"
                    }
                },
                ...etc
            ]
        },
        {
            "story": {
                "ID": "EV10-JOPK-88UH",
                "name": "Story B",
                "type": "scorm",
                "app": {
                    "ID": "io.falkor.acme",
                    "name": "Acme App",
                    "version": "2.9.0"
                }
            },
            "logs": [
                {
                    "firstname": "User",
                    "lastname": "Two",
                    "email": "[e-mail]",
                    "telephone": "",
                    "country": "South Africa",
                    "city": "Cape Town",
                    "groups": [],
                    "status": {
                        "complete": true,
                        "duration": 19,
                        "attempts": 1,
                        "started": "2022-02-24T14:56:32+02:00",
                        "updated": "2022-02-24T14:56:53+02:00"
                    }
                },
                ...etc
            ]
        },
        ...etc
    ],
    "hash": "b00bb9cc0573f8b4e153a5cd4421dc67",
    "response_time": 0.3414289951324463
}

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
email	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.