Skip to main content
GET
The deanonymized visitor feed

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Query Parameters

type
enum<string>
required

Which feed to return: people (identified visitors, one row per person) or companies (visiting companies, one row per company); the feed is all-time, not windowed.

Available options:
people,
companies
page
integer
default:1

1-based page number, 1 to 10000 (default 1).

Required range: 1 <= x <= 10000
pageSize
integer
default:20

Rows per page, 1 to 100 (default 20).

Required range: 1 <= x <= 100

Free text, 1 to 200 characters; there is no vocabulary to look up. Matched as a case-insensitive substring against exactly one column: the person's name when type=people, the company name when type=companies — the people feed never matches a company name, so searching a company there returns 0 rows. The value is interpolated into a SQL LIKE pattern without escaping, so % and _ act as wildcards (search=% matches every row). Rows whose name was never resolved are excluded from both feeds whether or not search is sent. A value that matches nothing is not an error: the response is 200 with an empty visitors array.

Required string length: 1 - 200
sortBy
enum<string>
default:lastVisitDate

Field to sort the feed by (default lastVisitDate); count is the visit count and name the identified person's name.

Available options:
lastVisitDate,
count,
companyName,
name,
companySize,
companyIndustry,
department,
location,
confidenceInterval
sortOrder
enum<string>
default:desc

Sort direction, asc or desc (default desc).

Available options:
asc,
desc

Response

Success

visitors
object[]
required
pagination
object
required