GET FLOW

Query for the user inputs for an existing EyeLevel chat flow by flow ID

QUERY FLOW INPUTS

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

Path Parameters

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

Query Parameters

Name	Type	Description
period	string	Analytics of last n days

200

{
    "analytics": {
        "total": INTEGER,
        "inputs": [
            {
                "date":      DATETIME,
                "prompt:     "STRING",
                "userInput": "STRING",
                "userName":  "STRING"
            }
        ]
    }
}

default period = 1 day

Response

{
    "analytics": {
        "total": INTEGER,
        "inputs": [
            {
                "date":      DATETIME,
                "leadId":    "STRING IDENTIFIER",
                "name":      "STRING",
                "prompt":    "STRING",
                "userInput": "STRING"
            }
        ]
    }
}

date

The datetime the user input was captured in RFC3339 format.

leadId

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

name

The first and last name of the end user.

prompt

The text prompt that the end user saw prior to their input.

userInput

The text input the end user made in response to the prompt. If the end user clicked a button, the userInput is the button label.