Published

The analytics/published endpoint retrieves a list of content (stories, streams, pathways) published on the app. This endpoint is useful if the need to query content on the app before looking at various other analytic endpoints.

Parameters

The endpoint only takes a single optional parameter which allows filtering of apps

Key

Type

app

String (ID or name of app)

Example

The example below retrieves a list of apps with published content for each app.

curl -X POST \
  v1/analytics/published \
  -H 'Authorization: Basic <Your Base64 Encoded Token>'

Success Response

A successful response will have an array of app + content items.

{
    "status": "success",
    "data": [
        {
            "app": {
                "ID": "io.falkor.demo",
                "name": "Falkor",
                "version": "2.10.0"
            },
            "content": {
                "pathways": [
                    {
                        "ID": "EV67-ZCNS-56AD",
                        "name": "Pathway A",
                        "icon": "<content url>",
                        "type": "pathway"
                    },
                    {
                        "ID": "EV44-CXGM-88TI",
                        "name": "Pathway B",
                        "icon": "<content url>",
                        "type": "pathway"
                    },
                    ...etc
                ],
                "stories": [
                    {
                        "ID": "EV72-RQZY-80AH",
                        "name": "Story A",
                        "icon": "<content url>",
                        "type": "story"
                    },
                    {
                        "ID": "EV30-NNDN-79EE",
                        "name": "Story B",
                        "icon": "<content url>",
                        "type": "survey"
                    },
                    ...etc
                ],
                "streams": [
                    {
                        "ID": "EV93-RZXC-81KB",
                        "name": "Stream A",
                        "icon": "<content url>",
                    },
                    {
                        "ID": "EV63-OXFN-39QB",
                        "name": "Stream B",
                        "icon": "<content url>",
                        "type": "podcast"
                    },
                    ...etc
                ]
            }
        }
    ],
    "hash": "24a5bbfea32e4fc3d5e84e19243fc372",
    "response_time": 0.18273687362670898
}

App + Content Item

Key

Type

app

Object

app.ID

String (Reverse domain app identity)

app.name

String

app.version

String

content

Object

content.pathways

Array of pathway items

content.stories

Array of story items

content.streams

Array of stream items

Pathway Item

Key

Type

ID

String (SKU / ID of pathway)

name

String

icon

String (Icon URL of pathway)

type

String (Always pathway)

Story Item

Key

Type

ID

String (SKU / ID of story)

name

String

icon

String (Icon URL of story)

type

Enum (story, article, assessment, survey, scorm)

Stream Item

Key

Type

ID

String (SKU / ID of stream)

name

String

icon

String (Icon URL of story)

type

Enum (podcast, youtube, audio, video)

Last updated