Skip to content

Get Universal Activity Metrics

GET
/universal-activity/metrics

Activity metrics for a window.

tz is REQUIRED, deliberately: every bucket boundary is a local calendar day, so a default would silently bucket a customer’s data in the wrong timezone rather than failing loudly.

Authorizations

Parameters

Query Parameters

tz
required

IANA timezone name, e.g. America/New_York.

string

IANA timezone name, e.g. America/New_York.

range
string
default: today
Allowed values: today yesterday week month custom
scope

team is accepted for back-compat; the service aliases it to mine.

string
default: mine
Allowed values: mine all team

team is accepted for back-compat; the service aliases it to mine.

start_date
Any of:
string format: date

Custom range start, inclusive, in tz.

end_date
Any of:
string format: date

Custom range end, inclusive, in tz.

workspace_id
Any of:
string

Workspace UUID; omit for org-wide.

channel
Any of:
string

Restrict to one channel.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string