Adminserver: Analytics API

Endpoint	Method	Description
/files/analytics/userSessions	webRequest	Generate analytics: user sessions
/files/analytics/boothResourceVisits	webRequest	Generate analytics: booth resource visits
/files/analytics/conferenceVisits	webRequest	Generate analytics: conference visits
/files/analytics/contentVisits	webRequest	Generate analytics: content visits
/files/analytics/karaokeSongsPlayback	webRequest	Generate analytics: karaoke songs playback
/jsonRpc/analytics.registrations	jsonRpc	Registrations
/jsonRpc/analytics.sessions	jsonRpc	Sessions
/jsonRpc/analytics.rooms	jsonRpc	Rooms
/jsonRpc/analytics.roomVisits	jsonRpc	Room visits
/jsonRpc/analytics.propVisits	jsonRpc	Prop visits

Generate analytics: user sessions

HTTP Method: GET

Path: /files/analytics/userSessions

Description: Report represents users who created new sessions in provided amount of time.

Parameters:

startDate: timestamp

endDate: timestamp

Permissions:

network.manage /networkId

Request:

{ empty }

Response:

xlsx spreadsheet file

Generate analytics: booth resource visits

HTTP Method: GET

Path: /files/analytics/boothResourceVisits

Description: Report represents company booths, their content and time users spend looking at them.

Parameters:

roomId: string

propId: string

startDate: timestamp

endDate: timestamp

Permissions:

network.manage /networkId

room.manage /networkId/roomId (when roomId provided in request)

prop.manage /networkId/roomId/propId (when propId provided in request)

Request:

{ empty }

Response:

xlsx spreadsheet file

Generate analytics: conference visits

HTTP Method: GET

Path: /files/analytics/conferenceVisits

Description: Report represents accumulative visits of company booths and file cabinets per user.

Parameters:

roomId: string

propId: string

startDate: timestamp

endDate: timestamp

Permissions:

network.manage /networkId

room.manage /networkId/roomId (when roomId provided in request)

prop.manage /networkId/roomId/propId (when propId provided in request)

Request:

{ empty }

Response:

xlsx spreadsheet file

Generate analytics: content visits

HTTP Method: GET

Path: /files/analytics/contentVisits

Description: Report represents resources, their total views and time spent.

Parameters:

roomId: string

propId: string

startDate: timestamp

endDate: timestamp

Permissions:

network.manage /networkId

room.manage /networkId/roomId (when roomId provided in request)

prop.manage /networkId/roomId/propId (when propId provided in request)

Request:

{ empty }

Response:

xlsx spreadsheet file

Generate analytics: karaoke songs playback

HTTP Method: GET

Path: /files/analytics/karaokeSongsPlayback

Description: Report returns karaoke songs playback (30+ seconds).

Parameters:

startDate: timestamp

endDate: timestamp

Permissions:

network.manage /networkId

Request:

{ empty }

Response:

xlsx spreadsheet file

Registrations

Method: jsonRpc

HTTP Method: POST

Path: /jsonRpc/analytics.registrations

Permissions:

network.manage /networkId

Request:

{
    "localDate": timestamp
}

Response:

{
    "data": {
        "totalUsers": int
        "newUsersForLastWeek": [ int ]  // array of new users per each day
    }
    "error": { "status": bool, "code": int, "message": string }
}

Sessions

Method: jsonRpc

HTTP Method: POST

Path: /jsonRpc/analytics.sessions

Permissions:

network.manage /networkId

Request:

{
    "localDate": timestamp
}

Response:

{
    "data": {
        "newSessionsForLastWeek": [ int ]  // array of new sessions per each day
    }
    "error": { "status": bool, "code": int, "message": string }
}

Rooms

Method: jsonRpc

HTTP Method: POST

Path: /jsonRpc/analytics.rooms

Permissions:

network.manage /networkId

Request:

{ empty }

Response:

{
    "data": {
        "publicRooms": int
        "privateRooms": int
        "newRooms": int
    }
    "error": { "status": bool, "code": int, "message": string }
}

Room visits

Method: jsonRpc

HTTP Method: POST

Path: /jsonRpc/analytics.roomVisits

Permissions:

network.manage /networkId

room.manage /networkId/roomId

Request:

{
    "roomId": string
    "localDate": timestamp
}

Response:

{
    "data": {
        "roomVisitsForLastWeek": [ int ]  // array of room visits per each day
    }
    "error": { "status": bool, "code": int, "message": string }
}

Prop visits

Method: jsonRpc

HTTP Method: POST

Path: /jsonRpc/analytics.propVisits

Permissions:

network.manage /networkId

room.manage /networkId/roomId

prop.manage /networkId/roomId/propId

Request:

{
    "propId": string
    "roomId": string
    "localDate": timestamp
}

Response:

{
    "data": {
        "propVisitsForLastWeek": [ int ]  // array of prop visits per each day
    }
    "error": { "status": bool, "code": int, "message": string }
}