Skip to main content
GET
Get activity statistics for a company.

Authorizations

x-api-key
string
header
required

Path Parameters

company_uuid
string
required

Query Parameters

periods
string | null

Comma-separated list of periods to retrieve stats for. Valid values: '30_days', '90_days', '180_days', '365_days', 'all_time'. If not specified, returns all available periods.

group_by
string | null

Optional grouping. internal_user returns a per-user breakdown under by_user in addition to the aggregate periods.

Allowed value: "internal_user"
sort_by
string | null

Optional. top_user populates top_email_user and top_meeting_user (each user's name + 90-day counts) without requiring group_by=internal_user's full by_user array. Combine with group_by=internal_user to get both.

Allowed value: "top_user"

Response

200 - application/json

Activity statistics response for an entity.

Contains stats across multiple time periods (e.g., 30_days, 90_days, all_time). by_user is only populated when group_by=internal_user is passed (the full per-user breakdown); the top-level periods still carries the aggregate. top_email_user/top_meeting_user are the by_user entries with the highest emails/meetings count (90-day window) — populated whenever group_by=internal_user OR the lighter-weight sort_by=top_user is passed, without requiring the full by_user array. None when there's no internal-user activity for that metric.

entity_type
enum<string>
required
Available options:
PERSON,
COMPANY
entity_uuid
string
required
periods
ActivityStatsPeriod · object[]
required
by_user
ActivityStatsByUser · object[] | null
top_email_user
ActivityStatsByUser · object | null
top_meeting_user
ActivityStatsByUser · object | null