Room Analytics API

Endpoint	Method	Description
analytics:userEnteredBooth	websocket	Analytics: user entered booth
analytics:userExitedBooth	websocket	Analytics: user exited booth
analytics:userOpenedFileCabinet	websocket	Analytics: user opened file cabinet
analytics:userOpenedPDF	websocket	Analytics: user opened pDF
analytics:userDownloadedPDF	websocket	Analytics: user downloaded pDF
analytics:userPrintedPDF	websocket	Analytics: user printed pDF
analytics:userListenedKaraokeSong	websocket	Analytics: user listened karaoke song

Analytics: user entered booth

Method: websocket

Endpoint: analytics:userEnteredBooth

Request:

{
    "data": {
        "roomId": string
        "propId": string
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "error": { "status": bool, "code": int, "message": string }
}

Analytics: user exited booth

Method: websocket

Endpoint: analytics:userExitedBooth

Request:

{
    "data": {
        "roomId": string
        "propId": string
        "resourceAnalytics": [{
            "resourceId": string
            "contentType": string
            "secondsSpent": int
        }]
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "error": { "status": bool, "code": int, "message": string }
}

Analytics: user opened file cabinet

Method: websocket

Endpoint: analytics:userOpenedFileCabinet

Request:

{
    "data": {
        "roomId": string
        "propId": string
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "error": { "status": bool, "code": int, "message": string }
}

Analytics: user opened pDF

Method: websocket

Endpoint: analytics:userOpenedPDF

Request:

{
    "data": {
        "resourceId": string
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "error": { "status": bool, "code": int, "message": string }
}

Analytics: user downloaded pDF

Method: websocket

Endpoint: analytics:userDownloadedPDF

Request:

{
    "data": {
        "resourceId": string
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "error": { "status": bool, "code": int, "message": string }
}

Analytics: user printed pDF

Method: websocket

Endpoint: analytics:userPrintedPDF

Request:

{
    "data": {
        "resourceId": string
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "error": { "status": bool, "code": int, "message": string }
}

Analytics: user listened karaoke song

Method: websocket

Endpoint: analytics:userListenedKaraokeSong

Request:

{
    "data": {
        "roomId": string
        "roomName": string
        "songId": string
        "songTitle": string
        "songArtist": string
        "duration": int
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "error": { "status": bool, "code": int, "message": string }
}