Search Web Visits

POST

/v1/web-visits

Search for web visits within a date range. Returns a paginated list of visit records including engagement data, visitor information, and location. Visits can be narrowed with the simple inline filters or with a custom-feed-style advanced_filters tree (one or the other, not both).

INFO

Requires the web_visits:read OAuth2 scope.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Query Params

Body Params application/jsonRequired

Examples

Search visits with advanced filtersBasic date range searchSearch visits for a specific company

Search visits of companies matching a custom-feed-style filter tree — here, companies from Germany whose visitors viewed a pricing page.

{
    "advanced_filters": {
        "items": [
            {
                "items": [
                    {
                        "items": [
                            {
                                "items": [
                                    {
                                        "field": "country_code",
                                        "operator": "is",
                                        "type": "filter",
                                        "value": "DE"
                                    }
                                ],
                                "operator": "or",
                                "type": "group"
                            },
                            {
                                "items": [
                                    {
                                        "field": "page_url",
                                        "operator": "contains",
                                        "type": "filter",
                                        "value": "/pricing"
                                    }
                                ],
                                "operator": "or",
                                "type": "group"
                            }
                        ],
                        "operator": "and",
                        "type": "group"
                    }
                ],
                "operator": "or",
                "type": "group"
            },
            {
                "items": [],
                "negated": true,
                "operator": "or",
                "type": "group"
            }
        ],
        "operator": "and",
        "type": "group",
        "version": 1
    },
    "end_date": "2026-01-31",
    "start_date": "2026-01-01"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Search visits with advanced filtersBasic date range searchSearch visits for a specific company

curl --location --globoff 'https://api.leadfeeder.com/v1/web-visits?account_id=123456&page[num]=1&page[size]=20&include=company' \
--header 'X-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "advanced_filters": {
        "items": [
            {
                "items": [
                    {
                        "items": [
                            {
                                "items": [
                                    {
                                        "field": "country_code",
                                        "operator": "is",
                                        "type": "filter",
                                        "value": "DE"
                                    }
                                ],
                                "operator": "or",
                                "type": "group"
                            },
                            {
                                "items": [
                                    {
                                        "field": "page_url",
                                        "operator": "contains",
                                        "type": "filter",
                                        "value": "/pricing"
                                    }
                                ],
                                "operator": "or",
                                "type": "group"
                            }
                        ],
                        "operator": "and",
                        "type": "group"
                    }
                ],
                "operator": "or",
                "type": "group"
            },
            {
                "items": [],
                "negated": true,
                "operator": "or",
                "type": "group"
            }
        ],
        "operator": "and",
        "type": "group",
        "version": 1
    },
    "end_date": "2026-01-31",
    "start_date": "2026-01-01"
}'

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

{
    "data": [
        {
            "attributes": {
                "campaign": "Homepage Split",
                "device_type": "smartphone",
                "engagements": [
                    {
                        "event_type": "page-view",
                        "has_met_goals": false,
                        "hostname": "www.leadfeeder.com",
                        "id": "b4ebc08c-8c1f-11f1-9b9e-633b755451a0_0",
                        "page": {
                            "path": "/pricing/",
                            "title": "Pricing for all stages of growth",
                            "url": "http://www.leadfeeder.com/pricing/"
                        },
                        "previous_page_path": "(entrance)",
                        "time": "2026-01-15T10:30:00+02:00",
                        "time_on_page": 22
                    }
                ],
                "identifiers": {
                    "adobe_cookies": [],
                    "ga_client_ids": [
                        "5829104736.1742616961"
                    ],
                    "lf_client_id": "LF1.1.a3f8b2d1e4c90123.1742597607000"
                },
                "keyword": "website leads",
                "landing_page_path": "/home",
                "medium": "cpc",
                "page_depth": 4,
                "referring_url": "https://www.google.com/search?q=leadfeeder",
                "source": "google",
                "started_at": "2026-01-15T10:30:00.000Z",
                "visit_length": 80,
                "visitor": {
                    "email": null,
                    "first_name": null,
                    "last_name": null
                }
            },
            "id": "5b4f313e-46de-11e8-b981-05bebed8e58b",
            "relationships": {
                "company": {
                    "id": "129011",
                    "type": "company"
                },
                "location": {
                    "attributes": {
                        "city": "Helsinki",
                        "country": "Finland",
                        "country_code": "FI",
                        "geonames_id": "658225",
                        "postal_code": "00100",
                        "region": "Uusimaa"
                    },
                    "id": "6xeTMh2VfiAzFd86n7GNJ3",
                    "type": "visit_location"
                }
            },
            "type": "web_visit"
        }
    ],
    "meta": {
        "pagination": {
            "page_count": 1,
            "page_num": 1,
            "total_count": 1
        },
        "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠422Parameter Error

🟠429Server Error

🔴500Server Error

🔴504Gateway Timeout

Modified at 2026-09-17 07:46:23

Custom Feed - Filter Reference

Retrieve Visitor Companies