List users
The window's users, anonymous visitors included (identified ones only with identified_only=true, and only users not seen in the 90 days before the window with new_only=true), with their traits and activity, highest sort value first (last_seen by default), a page at a time (meta.nextCursor). search matches part of the user id, or of a profile's name or email trait; traits (a JSON object) keeps the users whose profile holds those traits.
Requires users:read on the site (an API key, or a signed-in member's role). Share links: allowed, with the users:read scope.
x-api-key<token>An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).
Scope: users:read
siteId*stringstart?stringend?stringlast?stringall?"true""true"tz?stringbucket?string"minute""5m""15m""hour""day""week""month""year"filters?stringlength <= 64000segment?string^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidsort?string"last_seen""last_seen""first_seen""sessions""pageviews""events"identified_only?stringnew_only?stringsearch?string1 <= length <= 100traits?stringlength <= 2000cursor?stringlength <= 2200limit?integer1 <= value <= 20050OK
application/json- response
data*array<>meta*curl -X GET 'https://pilotfox.app/api/v1/sites/string/users'{ "data": [ { "user_id": "string", "identified": true, "first_seen": "string", "last_seen": "string", "sessions": 0, "pageviews": 0, "events": 0, "visitors": 0, "country": "string", "region": "string", "city": "string", "device_type": "string", "browser": "string", "os": "string", "is_new": true, "traits": { "property1": "string", "property2": "string" } } ], "meta": { "window": { "from": "string", "to": "string", "tz": "string", "bucket": "minute" }, "compare": { "from": "string", "to": "string" }, "totalCount": -9007199254740991, "nextCursor": "string", "truncated": true, "cache": "hit" }}