GET FLOW

Query for end user information for a given flow ID

QUERY FLOW

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

Path Parameters

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

Query Parameters

Name	Type	Description
format	string	Response format csv = tab formatted CSV
complete	boolean	Filter users who completed the chat flow true = include end users who completed the chat flow false = include all users who entered the chat flow
period	string	Analytics of last n days

200

{
    "analytics": {
        "end":   DATETIME,
        "start": DATETIME,
        "total": INTEGER,
        "users": [
            {
                "didComplete": BOOLEAN,
                "email":       "STRING",
                "id":          "STRING IDENTIFIER",
                "ipAddress":   "STRING",
                "labels": {
                    KEY: VALUE,
                },
                "leadId":      "STRING IDENTIFIER",
                "name":        "STRING",
                "platform":    "ENUMERATED STRING",
                "phone":       "STRING",
                "origin":      "STRING",
                "timestamp":   INTEGER,
                "userAgent":   "STRING",
                "versionId":   "STRING IDENTIFIER"
            }
        ]
    }
}

default format = JSON

default complete = false

default period = 1 day

Response

{
    "analytics": {
        "end":   DATETIME,
        "start": DATETIME,
        "total": INTEGER,
        "users": [
            {
                "didComplete": BOOLEAN,
                "email":       "STRING",
                "id":          "STRING IDENTIFIER",
                "ipAddress":   "STRING",
                "labels": {
                    KEY: VALUE,
                },
                "leadId":      "STRING IDENTIFIER",
                "name":        "STRING",
                "platform":    "ENUMERATED STRING",
                "phone":       "STRING",
                "origin":      "STRING",
                "timestamp":   INTEGER,
                "userAgent":   "STRING",
                "versionId":   "STRING IDENTIFIER"
            }
        ]
    }
}

didComplete

A boolean value describing whether the end user completed the chat flow.

end

The datetime for the end of the date range for the current query in RFC3339 format.

start

The datetime for the start of the date range for the current query in RFC3339 format.

total

The total number of end users that are in results of the current query.

email

The email address of the end user that was captured in chat.

id

The unique identifier for the flow that the end user most recently engaged in.

ipAddress

The most recently detected IPv4 address of the end user.

labels

A dictionary of key-values for custom end user information that was captured in chat. Custom labels can be defined within a chat flow as a custom user input, labelled button click, or user tag.

leadId

The unique identifier for the end user. This value can be used in other analytics queries.

name

The name of the end user that was captured in chat.

platform

The marketing channel where the chat flow is published. The value must be one of:

• qr - for QR codes

• web - for websites

• linkedin - for LinkedIn ads

• instagram - for Instagram web ads

• email - for email marketing

• gads - for Google search ads

• fbads - for Facebook web ads

• facebook - for Facebook platform Messenger ads (includes Instagram)

• youtube - for YouTube ads

• fbpage - for Facebook Pages

The different marketing channels are described in greater detail here.

phone

The phone number of the end user that was captured in chat.

origin

The full URL that the end user launched the chat from.

timestamp

The unix timestamp when the end user information was last updated.

userAgent

The most recently detected user agent for the end user.

versionId

The unique version identifier for the flow that the end user most recently engaged in.