GET FLOW

Query for chat flow summary analytics by the flow ID

QUERY FLOW SUMMARY

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

Path Parameters

Name	Type	Description
apiKey	string	EyeLevel customer key
id	string	Flow ID

Query Parameters

Name	Type	Description
type	string	Enumerated type of analytics query Must be one of: entered, engaged, completed, template, all
period	string	Analytics of last n days

200

{
    "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 as a result of this chat flow.

usersCompleted

The number of end users that reached some conclusion of this chat flow.

usersEngaged

The number of end users that took an action, by clicking a button or typing a message, in this chat flow.

usersEntered

The number of end users that saw the initial prompt of this chat flow.