Web Visits
v1

Retrieve Visitor Companies

Retrieve a paginated list of companies that visited your website within a given date range. Each item includes references to the company and its inferred geographic location.

:::info Requires the web_visits:read OAuth2 scope. :::

get/v1/web-visits/companies

Query parameters

account_idstring required

The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.

start_datestring date required

Start of the date range (ISO 8601).

end_datestring date required

End of the date range (ISO 8601).

page[num]integer

Page of results to fetch.

page[size]integer

The number of items per page. Maximum is 100.

custom_feed_idstring

Filter results to companies matching a specific custom feed.

include'company'

Specify which additional data should be attached to the result.

Response

Success

Example response

{
  "data": [
    {
      "type": "company_location",
      "id": "5b4f313e-46de-11e8-b981-05bebed8e58b",
      "relationships": {
        "company": {
          "id": "129011"
        },
        "location": {
          "type": "location",
          "id": "6xeTMh2VfiAzFd86n7GNJ3",
          "attributes": {
            "country": "Finland",
            "country_code": "FI",
            "region": "Uusimaa",
            "region_code": "FI-18",
            "city": "Helsinki",
            "geonames_id": "658225",
            "state_code": "FI-18"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page_num": 1,
      "page_count": 1,
      "total_count": 1
    },
    "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
  }
}

Changes

Changed in 3 of the 17 revisions of this API.10

    • added the optional property data/items/relationships/company/oneOf[CompanyV1]/relationships/icps/items/attributes/filters/location/items/type to the response with the 200 status

      response-optional-property-added

    • added the required property data/items/relationships/company/oneOf[CompanyV1]/attributes/app_url to the response with the 200 status

      response-required-property-added

    • added the required property data/items/relationships/company/oneOf[CompanyV1]/relationships/web_visits/items/attributes/engagements/items/oneOf[subschema #1: page-view]/allOf[subschema #1]/id to the response with the 200 status

      response-required-property-added

    • added the required property data/items/relationships/company/oneOf[CompanyV1]/relationships/web_visits/items/attributes/engagements/items/oneOf[subschema #1: page-view]/allOf[subschema #1]/time to the response with the 200 status

      response-required-property-added

    • added the required property data/items/relationships/company/oneOf[CompanyV1]/relationships/web_visits/items/attributes/engagements/items/oneOf[subschema #2: form-submit]/allOf[subschema #1]/id to the response with the 200 status

      response-required-property-added

    • added the required property data/items/relationships/company/oneOf[CompanyV1]/relationships/web_visits/items/attributes/engagements/items/oneOf[subschema #2: form-submit]/allOf[subschema #1]/time to the response with the 200 status

      response-required-property-added

    • added the required property data/items/relationships/company/oneOf[CompanyV1]/relationships/web_visits/items/attributes/engagements/items/oneOf[subschema #3: file-download]/allOf[subschema #1]/id to the response with the 200 status

      response-required-property-added

    • added the required property data/items/relationships/company/oneOf[CompanyV1]/relationships/web_visits/items/attributes/engagements/items/oneOf[subschema #3: file-download]/allOf[subschema #1]/time to the response with the 200 status

      response-required-property-added

    • added the required property data/items/relationships/company/oneOf[CompanyV1]/relationships/web_visits/items/attributes/engagements/items/oneOf[subschema #4: video-view]/allOf[subschema #1]/id to the response with the 200 status

      response-required-property-added

    • added the required property data/items/relationships/company/oneOf[CompanyV1]/relationships/web_visits/items/attributes/engagements/items/oneOf[subschema #4: video-view]/allOf[subschema #1]/time to the response with the 200 status

      response-required-property-added

Of the 17 revisions, 1 has no diff computed.