GET ALL

Query for chat flow summary analytics for all EyeLevel customer accounts that are associated with the given partner API key

QUERY ALL SUMMARY

GET https://api.eyelevel.ai/v1/partner/analytics

Query Parameters

NameTypeDescription

type

string

Enumerated type of analytics query Must be one of: entered, engaged, completed, template, all

period

string

Analytics of last n days

{
    "analytics": {
        "liveChats":      INTEGER,
        "usersCompleted": INTEGER,
        "usersEngaged":   INTEGER,
        "usersEntered":   INTEGER
    }
}

default type = all

default period = 1 day

Response

{
    "analytics": {
        "liveChats":      INTEGER,
        "usersCompleted": INTEGER,
        "usersEngaged":   INTEGER,
        "usersEntered":   INTEGER
    }
}

liveChats

The number of live chats that occurred for all accounts associated with the given partner API key.

usersCompleted

The number of end users that reached some conclusion of a chat flow for all accounts associated with the given partner API key.

usersEngaged

The number of end users that took an action, by clicking a button or typing a message, in a chat flow associated a customer account created with the given partner API key.

usersEntered

The number of end users that saw the initial prompt in a chat flow associated a customer account created with the given partner API key.

Last updated