Skip to main content
GET
Retrieve workspace analytics
Returns the numbers on a workspace’s Activity → Summary tab, one row per workspace. Pass filters[workspaceId] for specific workspaces, or leave it out to page through every workspace in the company. Every field is opt-in through properties[]. See Workspace analytics for what each number counts.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

properties
enum<string>[]

Select the numbers and nested fields to return. By default a row has only object and workspace (object, id, url); workspace.* adds fields to it.

Available options:
viewsCount,
timeSpentSeconds,
visitorsCount,
actionsCount,
lastViewedAt,
activitySummary,
workspace.name,
workspace.workspaceUrl,
workspace.createdAt,
workspace.updatedAt
filters
object

Filter the workspaces to report on. Without workspaceId, every workspace in the company is included.

page
integer

Page number

limit
integer

Number of results to return

Response

Retrieve the Activity tab's Summary numbers, one row per workspace

data
object