GET CUSTOMER FLOW

Search…
GET CUSTOMER FLOW
Query an existing EyeLevel chat flow by flow ID
get
https://api.eyelevel.ai/v1/partner
/flow/:apiKey/:id
QUERY
Response
{
    "flow": {
        "apiKey":      "STRING IDENTIFIER",
        "connections": [
            { CONNECTION OBJECT }
        ],
        "id":          "STRING IDENTIFIER",
        "name":        "STRING",
        "platform":    "ENUMERATED STRING",
        "platformId":  "STRING IDENTIFIER",
        "steps:        [
            { STEP OBJECT }
        ],
        "updated":     DATETIME,
        "versionId":   "STRING IDENTIFIER",
        "hoursId":     INTEGER,
        "themeId":     INTEGER,
        "qrThemeId":   INTEGER
    }
}
apiKey
The API key for the EyeLevel customer that owns the flow.
connections
An array of CONNECTION objects, containing information about how steps are connected to each other in the flow. Connections are described in greater detail here.
id
The unique identifier for the flow that was created with the request. You can use this id in other flow API requests.
name
The human readable name for the flow.
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.
platformId
The unique EyeLevel identifier for where the chat will be hosted.
steps
An array of STEP objects, containing information about each step in the flow. The definition of steps are described in greater detail here.
updated
The datetime the chat flow was created in RFC3339 format.
versionId
The unique identifier for the current version of the flow. If you update the flow using the id, you will create a new version of the flow with the same id but a different versionId.
hoursId
The unique integer identifier for the off hours setting applied to the flow.
themeId
The unique integer identifier for the theme applied to the flow.
qrThemeId
The unique integer identifier for the QR theme applied to the flow.