Help centerWeb SDKMobile SDKREST API

Searching funnels for drop-off users

Suggest Edits

You can use the REST API to search your funnels for users that have dropped off. For more information, see Get funnel visitors drop-off list in the API documentation.

Searching funnels for drop-off users

To search funnels for drop-off users using the REST API, you can use a GET call:

GET https://api.eu.smartlook.cloud/api/v1/funnels/<funnelId>/visitors/drop-off?dateFrom=2023-06-10&dateTo=2023-06-13&step=1&success=true

You can use four query parameters as seen in the example:

Query parameterShown in exampleDescription
dateFromdateFrom=2023-06-10The date to start the search
dateTodateTo=2023-06-13The date to end the search
stepstep=1The step of the funnel you want to search. The first step in your funnel is step 0.
success - true/falsesuccess=trueShows the list of users who:
true = continued to the step you entered earlier
false = dropped off before reaching the step you entered earlier

Example funnel search

Step 1: Find users using filters

Find a list of users that meets certain criteria:

//continued to step 3 but dropped off before step 4:
GET https://api.eu.smartlook.cloud/api/v1/funnels/<funnelId>/visitors/drop-off?dateFrom=2023-06-10&dateTo=2023-06-13&step=4&success=false

//completed step 4
GET https://api.eu.smartlook.cloud/api/v1/funnels/<funnelId>/visitors/drop-off?dateFrom=2023-06-10&dateTo=2023-06-13&step=4&success=true

Response:

{
    "totalVisitorsCount": 3,
    "visitors": ["visitor-id-1", "visitor-id-2", "visitor-id-3"]
}

Step 2: Search for users using visitors

POST https://api.eu.smartlook.cloud/api/v2/visitors/search
{
    "filters": [
        {
            "name": "visitor_id",
            "operator": "is",
            "value": ["visitor-id-1", "visitor-id-2", "visitor-id-3"]
        }
    ]
}

Response:

{
    "totalVisitorsCount": 3,
    "visitors": [
        {
            "id": "visitor-id-1",
            "identification": {
                "uid": null,
                "properties": [
                    {
                        "name": string,
                        "type": string,
                        "value": string
                    },
                ]
            },
            "firstSeen": "2023-05-30T12:50:10.606Z",
            "lastSeen": "2023-05-30T13:23:01.846Z",
            "numberOfVisits": 1,
            "_links": {
                "visitorSessions": "/api/v1/visitors/visitor-id-1/sessions",
                "visitorEvents": "/api/v1/visitors/visitor-id-1/events"
            }
        },
        ...
      ]
    "pagination": {
        "before": string,
        "after": string
    },
    "_links": {
        "previousPage": "/api/v2/visitors/search?before=<string>&limit=100",
        "nextPage": "/api/v2/visitors/search?after=<string>&limit=100"
    }

For more information, see Searching users.

Updated 9 months ago