Skip to main content
GET
Get visiting company activity via API key

Authorizations

X-API-Key
string
header
required

Organization API key (sk_...). Get yours from Settings > API Keys in the dashboard.

Headers

X-Whitelabel-Slug
string

Optional tenant context for admin-key operations without an organization target, such as creating an organization. Defaults to the master tenant. Must match an explicit target organization when both are supplied. Does not limit the key’s platform authority.

Required string length: 1 - 100
X-Organization-Id
string<uuid>

Target organization for admin-key requests on organization-context routes, including Data API, intent audiences and dashboard routes without an organization path parameter. Required on those routes. When supplied with an organization path parameter, both must identify the same organization; conflicting targets return 400. Does not grant access to customer credentials.

Path Parameters

companyKey
string
required

Opaque company key returned by the visiting company list.

Pattern: ^[a-f0-9]{64}$
Example:

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Query Parameters

window
enum<string>

Visit-time window; defaults to 30d when from/to are absent. Mutually exclusive with from/to.

Available options:
today,
24h,
3d,
7d,
14d,
30d,
mtd
Example:

"30d"

from
string<date-time>

Inclusive visit timestamp. Requires to; custom range maximum 366 days.

Example:

"2026-09-01T00:00:00Z"

to
string<date-time>

Exclusive visit timestamp. Requires from; future end is clamped to request time.

Example:

"2026-09-11T00:00:00Z"

timezone
string
default:UTC

IANA timezone used for calendar presets and daily time-series buckets; defaults to UTC.

Maximum string length: 100
Example:

"America/New_York"

classification
enum<string>
default:company

Dashboard view. Defaults to company, which includes company and unclassified_organization associations but excludes ISPs. Select isp for ISP associations only, or unclassified_organization for that subset only. Blank names and Unknown company placeholders are excluded from every view, ignoring case and surrounding whitespace. Response classification preserves the evidence classification, not the selected view. No company found results are not listed.

Available options:
company,
isp,
unclassified_organization
Example:

"company"

pixelId
string<uuid>

Optional authorized pixel. Omitted means every pixel visible to the caller in this organization.

Example:

"20000000-0000-4000-8000-000000000001"

page
integer
default:1

One-based activity page, ordered by visit time descending with stable pixel/event-key ties.

Required range: 1 <= x <= 1000
Example:

1

limit
integer
default:25

Activity records per page, from 1 to 100.

Required range: 1 <= x <= 100
Example:

25

Response

Company and masked activity, or an empty scoped result.

data
object
required
pagination
object
required
meta
object
required