REST reference · Core Tools

Analytics

110 endpoints110 implementedAll modules →

GET /rest/v1.0/companies/{company_id}/analytics/activityAnalytics audit trail (company admins only)
GET /rest/v1.0/companies/{company_id}/analytics/admin/orphanedContent owned by inactive users (company admins only)
GET /rest/v1.0/companies/{company_id}/analytics/alertsList KPI alert rules
POST /rest/v1.0/companies/{company_id}/analytics/alertsCreate a KPI alert rule
GET /rest/v1.0/companies/{company_id}/analytics/alerts/{id}Show a KPI alert rule
PATCH /rest/v1.0/companies/{company_id}/analytics/alerts/{id}Update a KPI alert rule
DELETE /rest/v1.0/companies/{company_id}/analytics/alerts/{id}Delete a KPI alert rule
POST /rest/v1.0/companies/{company_id}/analytics/alerts/{id}/transferTransfer an alert to a new owner (analytics admin only)
POST /rest/v1.0/companies/{company_id}/analytics/askAnswer a question with a governed query
GET /rest/v1.0/companies/{company_id}/analytics/catalogCatalog of metrics and dimensions readable by the caller (company)
GET /rest/v1.0/companies/{company_id}/analytics/catalog/{key}/usageWhere a metric or dimension key is used
GET /rest/v1.0/companies/{company_id}/analytics/commentsA thread (oldest first)
POST /rest/v1.0/companies/{company_id}/analytics/commentsComment on a dashboard, exploration, insight or goal
PATCH /rest/v1.0/companies/{company_id}/analytics/comments/{id}Edit (author) or resolve / reopen (anyone who can open the target) a comment
DELETE /rest/v1.0/companies/{company_id}/analytics/comments/{id}Delete a comment (author, or analytics admin at the target's scope)
GET /rest/v1.0/companies/{company_id}/analytics/comments/mentionablePeople who can open the target (mention and assignee picker)
GET /rest/v1.0/companies/{company_id}/analytics/dashboardsList dashboards (company)
POST /rest/v1.0/companies/{company_id}/analytics/dashboardsCreate a dashboard (company)
GET /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}Show a dashboard (company)
PATCH /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}Update a dashboard (company)
DELETE /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}Delete a dashboard (company)
POST /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/cloneClone a dashboard into a new private copy
GET /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/dataGet a dashboard's computed tile data (company)
POST /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/restoreRestore a deleted dashboard from trash (owner or analytics admin)
GET /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/revisionsList saved versions of a dashboard (newest first, max 50)
POST /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/revisions/{v}/restoreRestore a saved version of a dashboard (as a new version)
GET /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/sharesList who a dashboard is shared with (owner or analytics admin)
PUT /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/sharesReplace the dashboard share set (owner or analytics admin; audited). Grants the dashboard, never data.
POST /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/transferTransfer a dashboard to a new owner (analytics admin; reaches private items of inactive owners only)
GET /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/viewsList the dashboard's saved filter views you can see (your own and shared ones)
POST /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/viewsSave a filter view on a dashboard (personal unless shared by a dashboard editor)
GET /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/views/{view_id}Show a saved filter view
PATCH /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/views/{view_id}Rename, change or (un)share a saved filter view
DELETE /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/views/{view_id}Delete a saved filter view
GET /rest/v1.0/companies/{company_id}/analytics/dimensionsList company value groups
POST /rest/v1.0/companies/{company_id}/analytics/dimensionsCreate a value group
GET /rest/v1.0/companies/{company_id}/analytics/dimensions/{id}Get a value group
PATCH /rest/v1.0/companies/{company_id}/analytics/dimensions/{id}Edit a value group
DELETE /rest/v1.0/companies/{company_id}/analytics/dimensions/{id}Archive a value group
POST /rest/v1.0/companies/{company_id}/analytics/dimensions/{id}/publishRestore an archived value group
GET /rest/v1.0/companies/{company_id}/analytics/dimensions/valuesDistinct values of a dimension
GET /rest/v1.0/companies/{company_id}/analytics/explorationsList saved explorations
POST /rest/v1.0/companies/{company_id}/analytics/explorationsSave an exploration
GET /rest/v1.0/companies/{company_id}/analytics/explorations/{id}Show an exploration
PATCH /rest/v1.0/companies/{company_id}/analytics/explorations/{id}Update an exploration
DELETE /rest/v1.0/companies/{company_id}/analytics/explorations/{id}Delete an exploration
GET /rest/v1.0/companies/{company_id}/analytics/explorations/{id}/dataGet a saved exploration's result
POST /rest/v1.0/companies/{company_id}/analytics/explorations/{id}/restoreRestore a deleted exploration from trash (owner or analytics admin)
GET /rest/v1.0/companies/{company_id}/analytics/explorations/{id}/revisionsList saved versions of a exploration (newest first, max 50)
POST /rest/v1.0/companies/{company_id}/analytics/explorations/{id}/revisions/{v}/restoreRestore a saved version of a exploration (as a new version)
GET /rest/v1.0/companies/{company_id}/analytics/explorations/{id}/sharesList who a exploration is shared with (owner or analytics admin)
PUT /rest/v1.0/companies/{company_id}/analytics/explorations/{id}/sharesReplace the exploration share set (owner or analytics admin; audited). Grants the exploration, never data.
POST /rest/v1.0/companies/{company_id}/analytics/explorations/{id}/transferTransfer a exploration to a new owner (analytics admin; reaches private items of inactive owners only)
POST /rest/v1.0/companies/{company_id}/analytics/exportsStart an export job
GET /rest/v1.0/companies/{company_id}/analytics/exports/{id}Export job status
GET /rest/v1.0/companies/{company_id}/analytics/exports/{id}/downloadDownload your copy of an export or scheduled delivery
GET /rest/v1.0/companies/{company_id}/analytics/goalsList goals
POST /rest/v1.0/companies/{company_id}/analytics/goalsCreate a goal
GET /rest/v1.0/companies/{company_id}/analytics/goals/{id}Get a goal
PATCH /rest/v1.0/companies/{company_id}/analytics/goals/{id}Update a goal
DELETE /rest/v1.0/companies/{company_id}/analytics/goals/{id}Delete a goal
GET /rest/v1.0/companies/{company_id}/analytics/goals/{id}/checkinsList a goal's check-ins
POST /rest/v1.0/companies/{company_id}/analytics/goals/{id}/checkinsCheck in on a goal
GET /rest/v1.0/companies/{company_id}/analytics/goals/{id}/valueA goal's value, computed now as the caller
GET /rest/v1.0/companies/{company_id}/analytics/healthAnalytics data health
GET /rest/v1.0/companies/{company_id}/analytics/insightsList insights visible to the caller
PATCH /rest/v1.0/companies/{company_id}/analytics/insights/{id}Dismiss / reopen an insight, give it a reason, or assign it
POST /rest/v1.0/companies/{company_id}/analytics/insights/{id}/taskCreate (or return) the task for a project insight
POST /rest/v1.0/companies/{company_id}/analytics/insights/evaluateEvaluate insight rules now (analytics admin)
GET /rest/v1.0/companies/{company_id}/analytics/metricsList company custom metrics
POST /rest/v1.0/companies/{company_id}/analytics/metricsCreate a custom metric (draft)
GET /rest/v1.0/companies/{company_id}/analytics/metrics/{id}Get a custom metric
PATCH /rest/v1.0/companies/{company_id}/analytics/metrics/{id}Edit a custom metric (new version)
DELETE /rest/v1.0/companies/{company_id}/analytics/metrics/{id}Archive a custom metric
POST /rest/v1.0/companies/{company_id}/analytics/metrics/{id}/publishPublish a custom metric
GET /rest/v1.0/companies/{company_id}/analytics/metrics/{id}/versionsCustom metric version history (newest first)
POST /rest/v1.0/companies/{company_id}/analytics/metrics/{id}/versions/{v}/restoreRestore a custom metric version (as a new version)
POST /rest/v1.0/companies/{company_id}/analytics/metrics/previewPreview an unsaved custom metric definition
GET /rest/v1.0/companies/{company_id}/analytics/packsList report packs
GET /rest/v1.0/companies/{company_id}/analytics/packs/{key}Show a report pack
POST /rest/v1.0/companies/{company_id}/analytics/packs/{key}/cloneClone a pack into a saved dashboard (a copy; pack_key set)
GET /rest/v1.0/companies/{company_id}/analytics/packs/{key}/dataGet a report pack's computed tile data
GET /rest/v1.0/companies/{company_id}/analytics/queryRun an analytics query (company, GET form)
POST /rest/v1.0/companies/{company_id}/analytics/queryRun an analytics query (company)
POST /rest/v1.0/companies/{company_id}/analytics/query/batchRun several analytics queries in one call
POST /rest/v1.0/companies/{company_id}/analytics/query/detailRecords behind a result cell (company)
GET /rest/v1.0/companies/{company_id}/analytics/report-linksList report links
POST /rest/v1.0/companies/{company_id}/analytics/report-linksPublish a report link
DELETE /rest/v1.0/companies/{company_id}/analytics/report-links/{id}Revoke a report link
POST /rest/v1.0/companies/{company_id}/analytics/report-links/revoke-allRevoke every report link
GET /rest/v1.0/companies/{company_id}/analytics/schedulesList scheduled deliveries
POST /rest/v1.0/companies/{company_id}/analytics/schedulesCreate a scheduled delivery
GET /rest/v1.0/companies/{company_id}/analytics/schedules/{id}Show a scheduled delivery
PATCH /rest/v1.0/companies/{company_id}/analytics/schedules/{id}Update a scheduled delivery
DELETE /rest/v1.0/companies/{company_id}/analytics/schedules/{id}Delete a scheduled delivery
GET /rest/v1.0/companies/{company_id}/analytics/schedules/{id}/fileDownload the file behind an analytics.schedule.delivered webhook
POST /rest/v1.0/companies/{company_id}/analytics/schedules/{id}/runDeliver a schedule now
POST /rest/v1.0/companies/{company_id}/analytics/schedules/{id}/transferTransfer a schedule to a new owner (admin only)
GET /rest/v1.0/companies/{company_id}/analytics/settingsEffective analytics settings
PATCH /rest/v1.0/companies/{company_id}/analytics/settingsUpdate analytics settings (analytics admin)
GET /rest/v1.0/companies/{company_id}/analytics/storyProject Story (weekly brief or Today)
GET /rest/v1.0/projects/{project_id}/analytics/catalogCatalog of metrics and dimensions readable by the caller (project)
GET /rest/v1.0/projects/{project_id}/analytics/dashboardsList dashboards (project)
POST /rest/v1.0/projects/{project_id}/analytics/dashboardsCreate a dashboard (project)
GET /rest/v1.0/projects/{project_id}/analytics/dashboards/{id}Show a dashboard (project)
PATCH /rest/v1.0/projects/{project_id}/analytics/dashboards/{id}Update a dashboard (project)
DELETE /rest/v1.0/projects/{project_id}/analytics/dashboards/{id}Delete a dashboard (project)
GET /rest/v1.0/projects/{project_id}/analytics/queryRun an analytics query (project, GET form)
POST /rest/v1.0/projects/{project_id}/analytics/queryRun an analytics query (project)
POST /rest/v1.0/projects/{project_id}/analytics/query/detailRecords behind a result cell (project)

GET /rest/v1.0/companies/{company_id}/analytics/activity

Analytics audit trail (company admins only)

v1.0Implemented

Parameters

company_id
integerpathrequired
filters[actor_id]
integerquery
filters[action]
stringquery
filters[item_type]
stringquery
filters[from]
stringquery
filters[to]
stringquery
page
integerquery
per_page
integerquery

Response · 200 · `ActivityEvent[]`

id
integerrequired
created_at
stringrequired
actor_id
integerrequired
actor_name
string | nullrequired
action
stringrequired
item_type
stringrequired
item_id
integerrequired
project_id
integer | nullrequired
summary
stringrequired
changes
array | nullrequired

GET /rest/v1.0/companies/{company_id}/analytics/admin/orphaned

Content owned by inactive users (company admins only)

v1.0Implemented

Parameters

company_id
integerpathrequired

Response · 200 · `OrphanedItem[]`

type
stringrequired
id
integerrequired
name
stringrequired
project_id
integer | nullrequired
owner_id
integerrequired
owner_name
string | nullrequired
private
booleanrequired
enabled
boolean | nullrequired
owner_active
booleanrequired

GET /rest/v1.0/companies/{company_id}/analytics/alerts

List KPI alert rules

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery
page
integerquery
per_page
integerquery

Response · 200 · `AlertRule[]`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
metric_key
stringrequired
filters
object[]required
op
stringrequired
threshold
numberrequired
window
stringrequired
channel
stringrequired
recipient_ids
integer[]required
enabled
booleanrequired
last_evaluated_at
string | nullrequired
last_value
number | nullrequired
last_fired_at
string | nullrequired
created_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired
per_project
booleanrequired

POST /rest/v1.0/companies/{company_id}/analytics/alerts

Create a KPI alert rule

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery

Request body

alert
AlertRuleInputrequired

Response · 201 · `AlertRule`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
metric_key
stringrequired
filters
object[]required
op
stringrequired
threshold
numberrequired
window
stringrequired
channel
stringrequired
recipient_ids
integer[]required
enabled
booleanrequired
last_evaluated_at
string | nullrequired
last_value
number | nullrequired
last_fired_at
string | nullrequired
created_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired
per_project
booleanrequired

GET /rest/v1.0/companies/{company_id}/analytics/alerts/{id}

Show a KPI alert rule

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `AlertRule`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
metric_key
stringrequired
filters
object[]required
op
stringrequired
threshold
numberrequired
window
stringrequired
channel
stringrequired
recipient_ids
integer[]required
enabled
booleanrequired
last_evaluated_at
string | nullrequired
last_value
number | nullrequired
last_fired_at
string | nullrequired
created_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired
per_project
booleanrequired

PATCH /rest/v1.0/companies/{company_id}/analytics/alerts/{id}

Update a KPI alert rule

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Request body

alert
AlertRulePatchrequired

Response · 200 · `AlertRule`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
metric_key
stringrequired
filters
object[]required
op
stringrequired
threshold
numberrequired
window
stringrequired
channel
stringrequired
recipient_ids
integer[]required
enabled
booleanrequired
last_evaluated_at
string | nullrequired
last_value
number | nullrequired
last_fired_at
string | nullrequired
created_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired
per_project
booleanrequired

DELETE /rest/v1.0/companies/{company_id}/analytics/alerts/{id}

Delete a KPI alert rule

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 204

No response body.

POST /rest/v1.0/companies/{company_id}/analytics/alerts/{id}/transfer

Transfer an alert to a new owner (analytics admin only)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Request body

owner_id
integerrequired

Response · 200 · `AlertRule`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
metric_key
stringrequired
filters
object[]required
op
stringrequired
threshold
numberrequired
window
stringrequired
channel
stringrequired
recipient_ids
integer[]required
enabled
booleanrequired
last_evaluated_at
string | nullrequired
last_value
number | nullrequired
last_fired_at
string | nullrequired
created_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired
per_project
booleanrequired

POST /rest/v1.0/companies/{company_id}/analytics/ask

Answer a question with a governed query

v1.0Implemented

Parameters

company_id
integerpathrequired

Request body

question
stringrequired
project_id
integer

Response · 200 · `AskAnswer`

mapped
booleanrequired
engine
stringrequired
spec
QuerySpec | nullrequired
result
QueryResult | nullrequired
viz
VizSpec | nullrequired
chips
object[]required
explanation
stringrequired
alternatives
object[]required

GET /rest/v1.0/companies/{company_id}/analytics/catalog

Catalog of metrics and dimensions readable by the caller (company)

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery

Response · 200 · `Catalog`

metrics
object[]required
dimensions
object[]required
sources
object[]required
compat
objectrequired

GET /rest/v1.0/companies/{company_id}/analytics/catalog/{key}/usage

Where a metric or dimension key is used

v1.0Implemented

Parameters

company_id
integerpathrequired
key
stringpathrequired

Response · 200 · `Usage`

key
stringrequired
count
integerrequired
items
UsageItem[]required

GET /rest/v1.0/companies/{company_id}/analytics/comments

A thread (oldest first)

v1.0Implemented

Parameters

company_id
integerpathrequired
target
stringqueryrequired

Response · 200 · `Comment[]`

id
integerrequired
target_type
stringrequired
target_id
integerrequired
project_id
integer | nullrequired
tile_id
string | nullrequired
anchor
CommentAnchor | nullrequired
body
stringrequired
author_id
integerrequired
author_name
string | nullrequired
mentions
object[]required
resolved_at
string | nullrequired
resolved_by_id
integer | nullrequired
created_at
stringrequired
updated_at
stringrequired
can_edit
booleanrequired
can_delete
booleanrequired

POST /rest/v1.0/companies/{company_id}/analytics/comments

Comment on a dashboard, exploration, insight or goal

v1.0Implemented

Parameters

company_id
integerpathrequired
target
stringqueryrequired

Request body

comment
CommentInputrequired

Response · 201 · `Comment`

id
integerrequired
target_type
stringrequired
target_id
integerrequired
project_id
integer | nullrequired
tile_id
string | nullrequired
anchor
CommentAnchor | nullrequired
body
stringrequired
author_id
integerrequired
author_name
string | nullrequired
mentions
object[]required
resolved_at
string | nullrequired
resolved_by_id
integer | nullrequired
created_at
stringrequired
updated_at
stringrequired
can_edit
booleanrequired
can_delete
booleanrequired

PATCH /rest/v1.0/companies/{company_id}/analytics/comments/{id}

Edit (author) or resolve / reopen (anyone who can open the target) a comment

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Request body

comment
CommentPatchrequired

Response · 200 · `Comment`

id
integerrequired
target_type
stringrequired
target_id
integerrequired
project_id
integer | nullrequired
tile_id
string | nullrequired
anchor
CommentAnchor | nullrequired
body
stringrequired
author_id
integerrequired
author_name
string | nullrequired
mentions
object[]required
resolved_at
string | nullrequired
resolved_by_id
integer | nullrequired
created_at
stringrequired
updated_at
stringrequired
can_edit
booleanrequired
can_delete
booleanrequired

DELETE /rest/v1.0/companies/{company_id}/analytics/comments/{id}

Delete a comment (author, or analytics admin at the target's scope)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 204

No response body.

GET /rest/v1.0/companies/{company_id}/analytics/comments/mentionable

People who can open the target (mention and assignee picker)

v1.0Implemented

Parameters

company_id
integerpathrequired
target
stringqueryrequired

Response · 200 · `object[]`

id
integerrequired
name
stringrequired

GET /rest/v1.0/companies/{company_id}/analytics/dashboards

List dashboards (company)

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery
filters[visibility]
stringquery
filters[certified]
booleanquery
filters[favorite]
booleanquery
filters[shared_with_me]
booleanquery
page
integerquery
per_page
integerquery
filters[deleted]
booleanquery

Response · 200 · `Dashboard[]`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
pack_key
string | nullrequired
spec
DashboardSpecrequired
visibility
stringrequired
owner_id
integerrequired
certified
booleanrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
certified_by
integer | nullrequired
certified_at
string | nullrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

POST /rest/v1.0/companies/{company_id}/analytics/dashboards

Create a dashboard (company)

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery

Request body

dashboard
DashboardInputrequired

Response · 201 · `Dashboard`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
pack_key
string | nullrequired
spec
DashboardSpecrequired
visibility
stringrequired
owner_id
integerrequired
certified
booleanrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
certified_by
integer | nullrequired
certified_at
string | nullrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

GET /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}

Show a dashboard (company)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `Dashboard`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
pack_key
string | nullrequired
spec
DashboardSpecrequired
visibility
stringrequired
owner_id
integerrequired
certified
booleanrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
certified_by
integer | nullrequired
certified_at
string | nullrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

PATCH /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}

Update a dashboard (company)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Request body

dashboard
DashboardPatchrequired

Response · 200 · `Dashboard`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
pack_key
string | nullrequired
spec
DashboardSpecrequired
visibility
stringrequired
owner_id
integerrequired
certified
booleanrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
certified_by
integer | nullrequired
certified_at
string | nullrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

DELETE /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}

Delete a dashboard (company)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 204

No response body.

POST /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/clone

Clone a dashboard into a new private copy

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Request body

name
string

Response · 201 · `Dashboard`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
pack_key
string | nullrequired
spec
DashboardSpecrequired
visibility
stringrequired
owner_id
integerrequired
certified
booleanrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
certified_by
integer | nullrequired
certified_at
string | nullrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

GET /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/data

Get a dashboard's computed tile data (company)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
f
stringquery
filters[<filter key>]
stringquery
time_preset
stringquery
from
string (date)query
to
string (date)query
tile
stringquery
format
stringquery
view_id
integerquery

Response · 200 · `DashboardData`

target
objectrequired
project_id
integer | nullrequired
url
stringrequired
scope
stringrequired
filters_applied
string[]required
as_of
stringrequired
generated_at
stringrequired
timezone
stringrequired
tiles
object[]required

POST /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/restore

Restore a deleted dashboard from trash (owner or analytics admin)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `Dashboard`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
pack_key
string | nullrequired
spec
DashboardSpecrequired
visibility
stringrequired
owner_id
integerrequired
certified
booleanrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
certified_by
integer | nullrequired
certified_at
string | nullrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

GET /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/revisions

List saved versions of a dashboard (newest first, max 50)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `Revision[]`

version
integerrequired
name
stringrequired
actor_id
integerrequired
actor_name
string | nullrequired
created_at
stringrequired
current
booleanrequired
summary
stringrequired

POST /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/revisions/{v}/restore

Restore a saved version of a dashboard (as a new version)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
v
integerpathrequired

Request body

version
integer

Response · 200 · `Dashboard`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
pack_key
string | nullrequired
spec
DashboardSpecrequired
visibility
stringrequired
owner_id
integerrequired
certified
booleanrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
certified_by
integer | nullrequired
certified_at
string | nullrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

GET /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/shares

List who a dashboard is shared with (owner or analytics admin)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `ShareList`

shares
Share[]required

PUT /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/shares

Replace the dashboard share set (owner or analytics admin; audited). Grants the dashboard, never data.

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Request body

shares
object[]required

Response · 200 · `ShareList`

shares
Share[]required

POST /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/transfer

Transfer a dashboard to a new owner (analytics admin; reaches private items of inactive owners only)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Request body

owner_id
integerrequired

Response · 200 · `Dashboard`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
pack_key
string | nullrequired
spec
DashboardSpecrequired
visibility
stringrequired
owner_id
integerrequired
certified
booleanrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
certified_by
integer | nullrequired
certified_at
string | nullrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

GET /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/views

List the dashboard's saved filter views you can see (your own and shared ones)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `SavedView[]`

id
integerrequired
dashboard_id
integerrequired
name
stringrequired
state
FilterStaterequired
shared
booleanrequired
owner_id
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired

POST /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/views

Save a filter view on a dashboard (personal unless shared by a dashboard editor)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Request body

view
SavedViewInputrequired

Response · 201 · `SavedView`

id
integerrequired
dashboard_id
integerrequired
name
stringrequired
state
FilterStaterequired
shared
booleanrequired
owner_id
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired

GET /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/views/{view_id}

Show a saved filter view

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
view_id
integerpathrequired

Response · 200 · `SavedView`

id
integerrequired
dashboard_id
integerrequired
name
stringrequired
state
FilterStaterequired
shared
booleanrequired
owner_id
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired

PATCH /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/views/{view_id}

Rename, change or (un)share a saved filter view

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
view_id
integerpathrequired

Request body

view
SavedViewPatchrequired

Response · 200 · `SavedView`

id
integerrequired
dashboard_id
integerrequired
name
stringrequired
state
FilterStaterequired
shared
booleanrequired
owner_id
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired

DELETE /rest/v1.0/companies/{company_id}/analytics/dashboards/{id}/views/{view_id}

Delete a saved filter view

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
view_id
integerpathrequired

Response · 204

No response body.

GET /rest/v1.0/companies/{company_id}/analytics/dimensions

List company value groups

v1.0Implemented

Parameters

company_id
integerpathrequired

Response · 200 · `object`

value_groups
ValueGroup[]required

POST /rest/v1.0/companies/{company_id}/analytics/dimensions

Create a value group

v1.0Implemented

Parameters

company_id
integerpathrequired

Request body

dimension
ValueGroupInputrequired

Response · 201 · `ValueGroup`

id
integerrequired
key
stringrequired
label
stringrequired
description
stringrequired
base
stringrequired
base_label
stringrequired
groups
ValueGroupsrequired
other_label
stringrequired
version
integerrequired
status
stringrequired
updated_by_id
integerrequired
updated_at
string (date-time)required

GET /rest/v1.0/companies/{company_id}/analytics/dimensions/{id}

Get a value group

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `ValueGroup`

id
integerrequired
key
stringrequired
label
stringrequired
description
stringrequired
base
stringrequired
base_label
stringrequired
groups
ValueGroupsrequired
other_label
stringrequired
version
integerrequired
status
stringrequired
updated_by_id
integerrequired
updated_at
string (date-time)required

PATCH /rest/v1.0/companies/{company_id}/analytics/dimensions/{id}

Edit a value group

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Request body

dimension
ValueGroupPatchrequired
version
integer

Response · 200 · `ValueGroup`

id
integerrequired
key
stringrequired
label
stringrequired
description
stringrequired
base
stringrequired
base_label
stringrequired
groups
ValueGroupsrequired
other_label
stringrequired
version
integerrequired
status
stringrequired
updated_by_id
integerrequired
updated_at
string (date-time)required

DELETE /rest/v1.0/companies/{company_id}/analytics/dimensions/{id}

Archive a value group

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
force
booleanquery

Response · 200 · `ValueGroup`

id
integerrequired
key
stringrequired
label
stringrequired
description
stringrequired
base
stringrequired
base_label
stringrequired
groups
ValueGroupsrequired
other_label
stringrequired
version
integerrequired
status
stringrequired
updated_by_id
integerrequired
updated_at
string (date-time)required

POST /rest/v1.0/companies/{company_id}/analytics/dimensions/{id}/publish

Restore an archived value group

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `ValueGroup`

id
integerrequired
key
stringrequired
label
stringrequired
description
stringrequired
base
stringrequired
base_label
stringrequired
groups
ValueGroupsrequired
other_label
stringrequired
version
integerrequired
status
stringrequired
updated_by_id
integerrequired
updated_at
string (date-time)required

GET /rest/v1.0/companies/{company_id}/analytics/dimensions/values

Distinct values of a dimension

v1.0Implemented

Parameters

company_id
integerpathrequired
dim
stringqueryrequired
project_id
integerquery

Response · 200 · `object`

dim
stringrequired
metric
string | nullrequired
values
DimensionValue[]required

GET /rest/v1.0/companies/{company_id}/analytics/explorations

List saved explorations

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery
page
integerquery
per_page
integerquery
filters[deleted]
booleanquery

Response · 200 · `Exploration[]`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
query
QueryBodyrequired
viz
VizSpecrequired
visibility
stringrequired
owner_id
integerrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

POST /rest/v1.0/companies/{company_id}/analytics/explorations

Save an exploration

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery

Request body

exploration
ExplorationInputrequired

Response · 201 · `Exploration`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
query
QueryBodyrequired
viz
VizSpecrequired
visibility
stringrequired
owner_id
integerrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

GET /rest/v1.0/companies/{company_id}/analytics/explorations/{id}

Show an exploration

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `Exploration`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
query
QueryBodyrequired
viz
VizSpecrequired
visibility
stringrequired
owner_id
integerrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

PATCH /rest/v1.0/companies/{company_id}/analytics/explorations/{id}

Update an exploration

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Request body

exploration
ExplorationPatchrequired

Response · 200 · `Exploration`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
query
QueryBodyrequired
viz
VizSpecrequired
visibility
stringrequired
owner_id
integerrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

DELETE /rest/v1.0/companies/{company_id}/analytics/explorations/{id}

Delete an exploration

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 204

No response body.

GET /rest/v1.0/companies/{company_id}/analytics/explorations/{id}/data

Get a saved exploration's result

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
project_id
integerquery
time_preset
stringquery
from
string (date)query
to
string (date)query
format
stringquery

Response · 200 · `DashboardData`

target
objectrequired
project_id
integer | nullrequired
url
stringrequired
scope
stringrequired
filters_applied
string[]required
as_of
stringrequired
generated_at
stringrequired
timezone
stringrequired
tiles
object[]required

POST /rest/v1.0/companies/{company_id}/analytics/explorations/{id}/restore

Restore a deleted exploration from trash (owner or analytics admin)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
project_id
integerquery

Response · 200 · `Exploration`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
query
QueryBodyrequired
viz
VizSpecrequired
visibility
stringrequired
owner_id
integerrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

GET /rest/v1.0/companies/{company_id}/analytics/explorations/{id}/revisions

List saved versions of a exploration (newest first, max 50)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
project_id
integerquery

Response · 200 · `Revision[]`

version
integerrequired
name
stringrequired
actor_id
integerrequired
actor_name
string | nullrequired
created_at
stringrequired
current
booleanrequired
summary
stringrequired

POST /rest/v1.0/companies/{company_id}/analytics/explorations/{id}/revisions/{v}/restore

Restore a saved version of a exploration (as a new version)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
v
integerpathrequired
project_id
integerquery

Request body

version
integer

Response · 200 · `Exploration`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
query
QueryBodyrequired
viz
VizSpecrequired
visibility
stringrequired
owner_id
integerrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

GET /rest/v1.0/companies/{company_id}/analytics/explorations/{id}/shares

List who a exploration is shared with (owner or analytics admin)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
project_id
integerquery

Response · 200 · `ShareList`

shares
Share[]required

PUT /rest/v1.0/companies/{company_id}/analytics/explorations/{id}/shares

Replace the exploration share set (owner or analytics admin; audited). Grants the exploration, never data.

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
project_id
integerquery

Request body

shares
object[]required

Response · 200 · `ShareList`

shares
Share[]required

POST /rest/v1.0/companies/{company_id}/analytics/explorations/{id}/transfer

Transfer a exploration to a new owner (analytics admin; reaches private items of inactive owners only)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
project_id
integerquery

Request body

owner_id
integerrequired

Response · 200 · `Exploration`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
query
QueryBodyrequired
viz
VizSpecrequired
visibility
stringrequired
owner_id
integerrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

POST /rest/v1.0/companies/{company_id}/analytics/exports

Start an export job

v1.0Implemented

Parameters

company_id
integerpathrequired

Request body

export
ExportRequestrequired

Response · 202 · `ExportJob`

id
integerrequired
status
stringrequired
percent_complete
integerrequired
download_url
string | nullrequired
error
string | nullrequired

GET /rest/v1.0/companies/{company_id}/analytics/exports/{id}

Export job status

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `ExportJob`

id
integerrequired
status
stringrequired
percent_complete
integerrequired
download_url
string | nullrequired
error
string | nullrequired

GET /rest/v1.0/companies/{company_id}/analytics/exports/{id}/download

Download your copy of an export or scheduled delivery

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `string (binary)`

No documented fields.

GET /rest/v1.0/companies/{company_id}/analytics/goals

List goals

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery
page
integerquery
per_page
integerquery

Response · 200 · `Goal[]`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
metric_key
stringrequired
filters
object[]required
window
stringrequired
op
stringrequired
target
numberrequired
due_date
string | null (date)required
owner_id
integerrequired
owner_name
string | nullrequired
visibility
stringrequired
alert_when_behind
booleanrequired
alert_rule_id
integer | nullrequired
setting_key
string | nullrequired
created_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired
can_edit
booleanrequired
can_manage
booleanrequired
latest_check_in
GoalCheckIn | nullrequired

POST /rest/v1.0/companies/{company_id}/analytics/goals

Create a goal

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery

Request body

goal
GoalInputrequired

Response · 201 · `Goal`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
metric_key
stringrequired
filters
object[]required
window
stringrequired
op
stringrequired
target
numberrequired
due_date
string | null (date)required
owner_id
integerrequired
owner_name
string | nullrequired
visibility
stringrequired
alert_when_behind
booleanrequired
alert_rule_id
integer | nullrequired
setting_key
string | nullrequired
created_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired
can_edit
booleanrequired
can_manage
booleanrequired
latest_check_in
GoalCheckIn | nullrequired

GET /rest/v1.0/companies/{company_id}/analytics/goals/{id}

Get a goal

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `Goal`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
metric_key
stringrequired
filters
object[]required
window
stringrequired
op
stringrequired
target
numberrequired
due_date
string | null (date)required
owner_id
integerrequired
owner_name
string | nullrequired
visibility
stringrequired
alert_when_behind
booleanrequired
alert_rule_id
integer | nullrequired
setting_key
string | nullrequired
created_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired
can_edit
booleanrequired
can_manage
booleanrequired
latest_check_in
GoalCheckIn | nullrequired

PATCH /rest/v1.0/companies/{company_id}/analytics/goals/{id}

Update a goal

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Request body

goal
GoalPatchrequired

Response · 200 · `Goal`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
metric_key
stringrequired
filters
object[]required
window
stringrequired
op
stringrequired
target
numberrequired
due_date
string | null (date)required
owner_id
integerrequired
owner_name
string | nullrequired
visibility
stringrequired
alert_when_behind
booleanrequired
alert_rule_id
integer | nullrequired
setting_key
string | nullrequired
created_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired
can_edit
booleanrequired
can_manage
booleanrequired
latest_check_in
GoalCheckIn | nullrequired

DELETE /rest/v1.0/companies/{company_id}/analytics/goals/{id}

Delete a goal

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 204

No response body.

GET /rest/v1.0/companies/{company_id}/analytics/goals/{id}/checkins

List a goal's check-ins

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
page
integerquery
per_page
integerquery

Response · 200 · `GoalCheckIn[]`

id
integerrequired
goal_id
integerrequired
as_of
string (date)required
status
string | nullrequired
note
stringrequired
author_id
integerrequired
author_name
string | nullrequired
created_at
stringrequired

POST /rest/v1.0/companies/{company_id}/analytics/goals/{id}/checkins

Check in on a goal

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Request body

check_in
GoalCheckInInputrequired

Response · 201 · `GoalCheckIn`

id
integerrequired
goal_id
integerrequired
as_of
string (date)required
status
string | nullrequired
note
stringrequired
author_id
integerrequired
author_name
string | nullrequired
created_at
stringrequired

GET /rest/v1.0/companies/{company_id}/analytics/goals/{id}/value

A goal's value, computed now as the caller

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `GoalValue`

goal_id
integerrequired
value
number | nullrequired
unavailable
string | nullrequired
target
numberrequired
op
stringrequired
auto_status
string | nullrequired
status
stringrequired
status_source
stringrequired
as_of
string (date)required
history
array | nullrequired
history_note
string | nullrequired

GET /rest/v1.0/companies/{company_id}/analytics/health

Analytics data health

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery

Response · 200 · `Health`

generated_at
stringrequired
sources
object[]required
cache
object
snapshots
objectrequired
scope
objectrequired
slow_queries
array | nullrequired
slow_threshold_ms
numberrequired
gate
object
ticker
object

GET /rest/v1.0/companies/{company_id}/analytics/insights

List insights visible to the caller

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery
filters[severity]
stringquery
filters[domain]
stringquery
filters[status]
stringquery
page
integerquery
per_page
integerquery

Response · 200 · `Insight[]`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
rule_key
stringrequired
severity
stringrequired
type
stringrequired
domain
stringrequired
title
stringrequired
narrative
stringrequired
action
string | nullrequired
metric_keys
string[]required
tool
stringrequired
modeled
booleanrequired
magnitude
numberrequired
score
numberrequired
data
InsightDatarequired
status
stringrequired
first_seen_at
stringrequired
last_seen_at
stringrequired
assignee_id
integer | nullrequired
dismissed_by_id
integer | nullrequired
dismiss_reason
string | nullrequired
task_item_id
integer | nullrequired

PATCH /rest/v1.0/companies/{company_id}/analytics/insights/{id}

Dismiss / reopen an insight, give it a reason, or assign it

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Request body

insight
objectrequired

Response · 200 · `Insight`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
rule_key
stringrequired
severity
stringrequired
type
stringrequired
domain
stringrequired
title
stringrequired
narrative
stringrequired
action
string | nullrequired
metric_keys
string[]required
tool
stringrequired
modeled
booleanrequired
magnitude
numberrequired
score
numberrequired
data
InsightDatarequired
status
stringrequired
first_seen_at
stringrequired
last_seen_at
stringrequired
assignee_id
integer | nullrequired
dismissed_by_id
integer | nullrequired
dismiss_reason
string | nullrequired
task_item_id
integer | nullrequired

POST /rest/v1.0/companies/{company_id}/analytics/insights/{id}/task

Create (or return) the task for a project insight

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `InsightTask`

task_item_id
integerrequired
project_id
integerrequired
number
stringrequired
title
stringrequired
url
stringrequired
created
booleanrequired

POST /rest/v1.0/companies/{company_id}/analytics/insights/evaluate

Evaluate insight rules now (analytics admin)

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery

Response · 202 · `ExportJob`

id
integerrequired
status
stringrequired
percent_complete
integerrequired
download_url
string | nullrequired
error
string | nullrequired

GET /rest/v1.0/companies/{company_id}/analytics/metrics

List company custom metrics

v1.0Implemented

Parameters

company_id
integerpathrequired
status
stringquery

Response · 200 · `object`

metrics
CustomMetric[]required

POST /rest/v1.0/companies/{company_id}/analytics/metrics

Create a custom metric (draft)

v1.0Implemented

Parameters

company_id
integerpathrequired

Request body

metric
CustomMetricInputrequired

Response · 201 · `CustomMetric`

id
integerrequired
key
stringrequired
label
stringrequired
description
stringrequired
domain
stringrequired
unit
stringrequired
direction
stringrequired
definition
CustomMetricDefinitionrequired
summary
stringrequired
version
integerrequired
status
stringrequired
certified
booleanrequired
synonyms
string[]required
created_by_id
integerrequired
updated_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired

GET /rest/v1.0/companies/{company_id}/analytics/metrics/{id}

Get a custom metric

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `CustomMetric`

id
integerrequired
key
stringrequired
label
stringrequired
description
stringrequired
domain
stringrequired
unit
stringrequired
direction
stringrequired
definition
CustomMetricDefinitionrequired
summary
stringrequired
version
integerrequired
status
stringrequired
certified
booleanrequired
synonyms
string[]required
created_by_id
integerrequired
updated_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired

PATCH /rest/v1.0/companies/{company_id}/analytics/metrics/{id}

Edit a custom metric (new version)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Request body

metric
objectrequired
version
integer

Response · 200 · `CustomMetric`

id
integerrequired
key
stringrequired
label
stringrequired
description
stringrequired
domain
stringrequired
unit
stringrequired
direction
stringrequired
definition
CustomMetricDefinitionrequired
summary
stringrequired
version
integerrequired
status
stringrequired
certified
booleanrequired
synonyms
string[]required
created_by_id
integerrequired
updated_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired

DELETE /rest/v1.0/companies/{company_id}/analytics/metrics/{id}

Archive a custom metric

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
force
booleanquery

Response · 200 · `CustomMetric`

id
integerrequired
key
stringrequired
label
stringrequired
description
stringrequired
domain
stringrequired
unit
stringrequired
direction
stringrequired
definition
CustomMetricDefinitionrequired
summary
stringrequired
version
integerrequired
status
stringrequired
certified
booleanrequired
synonyms
string[]required
created_by_id
integerrequired
updated_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired

POST /rest/v1.0/companies/{company_id}/analytics/metrics/{id}/publish

Publish a custom metric

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `CustomMetric`

id
integerrequired
key
stringrequired
label
stringrequired
description
stringrequired
domain
stringrequired
unit
stringrequired
direction
stringrequired
definition
CustomMetricDefinitionrequired
summary
stringrequired
version
integerrequired
status
stringrequired
certified
booleanrequired
synonyms
string[]required
created_by_id
integerrequired
updated_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired

GET /rest/v1.0/companies/{company_id}/analytics/metrics/{id}/versions

Custom metric version history (newest first)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `object`

versions
CustomMetricVersion[]required

POST /rest/v1.0/companies/{company_id}/analytics/metrics/{id}/versions/{v}/restore

Restore a custom metric version (as a new version)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
v
integerpathrequired

Request body

version
integer

Response · 200 · `CustomMetric`

id
integerrequired
key
stringrequired
label
stringrequired
description
stringrequired
domain
stringrequired
unit
stringrequired
direction
stringrequired
definition
CustomMetricDefinitionrequired
summary
stringrequired
version
integerrequired
status
stringrequired
certified
booleanrequired
synonyms
string[]required
created_by_id
integerrequired
updated_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired

POST /rest/v1.0/companies/{company_id}/analytics/metrics/preview

Preview an unsaved custom metric definition

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery

Request body

definition
CustomMetricDefinitionrequired
label
string
unit
string
query
object

Response · 200 · `QueryResult`

columns
object[]required
rows
string | number | null[][]required
labels
objectrequired
totals
array | nullrequired
compare
object
truncated
booleanrequired
partial
object[]required
unavailable
object[]required
meta
objectrequired

GET /rest/v1.0/companies/{company_id}/analytics/packs

List report packs

v1.0Implemented

Parameters

company_id
integerpathrequired
filters[scope]
stringquery
filters[domain]
stringquery

Response · 200 · `Pack[]`

key
stringrequired
title
stringrequired
description
stringrequired
domain
stringrequired
scope
stringrequired
persona
stringrequired
dashboard
objectrequired

GET /rest/v1.0/companies/{company_id}/analytics/packs/{key}

Show a report pack

v1.0Implemented

Parameters

company_id
integerpathrequired
key
stringpathrequired

Response · 200 · `Pack`

key
stringrequired
title
stringrequired
description
stringrequired
domain
stringrequired
scope
stringrequired
persona
stringrequired
dashboard
objectrequired

POST /rest/v1.0/companies/{company_id}/analytics/packs/{key}/clone

Clone a pack into a saved dashboard (a copy; pack_key set)

v1.0Implemented

Parameters

company_id
integerpathrequired
key
stringpathrequired
project_id
integerquery

Request body

name
string

Response · 201 · `Dashboard`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
pack_key
string | nullrequired
spec
DashboardSpecrequired
visibility
stringrequired
owner_id
integerrequired
certified
booleanrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
certified_by
integer | nullrequired
certified_at
string | nullrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

GET /rest/v1.0/companies/{company_id}/analytics/packs/{key}/data

Get a report pack's computed tile data

v1.0Implemented

Parameters

company_id
integerpathrequired
key
stringpathrequired
project_id
integerquery
f
stringquery
filters[<filter key>]
stringquery
time_preset
stringquery
from
string (date)query
to
string (date)query
tile
stringquery
format
stringquery

Response · 200 · `DashboardData`

target
objectrequired
project_id
integer | nullrequired
url
stringrequired
scope
stringrequired
filters_applied
string[]required
as_of
stringrequired
generated_at
stringrequired
timezone
stringrequired
tiles
object[]required

GET /rest/v1.0/companies/{company_id}/analytics/query

Run an analytics query (company, GET form)

v1.0Implemented

Parameters

company_id
integerpathrequired
q
stringqueryrequired
format
stringquery
If-None-Match
stringheader

Response · 200 · `QueryResult`

columns
object[]required
rows
string | number | null[][]required
labels
objectrequired
totals
array | nullrequired
compare
object
truncated
booleanrequired
partial
object[]required
unavailable
object[]required
meta
objectrequired

POST /rest/v1.0/companies/{company_id}/analytics/query

Run an analytics query (company)

v1.0Implemented

Parameters

company_id
integerpathrequired

Request body

query
QuerySpecrequired

Response · 200 · `QueryResult`

columns
object[]required
rows
string | number | null[][]required
labels
objectrequired
totals
array | nullrequired
compare
object
truncated
booleanrequired
partial
object[]required
unavailable
object[]required
meta
objectrequired

POST /rest/v1.0/companies/{company_id}/analytics/query/batch

Run several analytics queries in one call

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery

Request body

queries
QuerySpec[]required

Response · 200 · `QueryBatchResult`

items
object[]required

POST /rest/v1.0/companies/{company_id}/analytics/query/detail

Records behind a result cell (company)

v1.0Implemented

Parameters

company_id
integerpathrequired

Request body

query
QuerySpecrequired
cell
object[]required
metric
string
cursor
string | null
columns
string[]
sort
object
limit
integer
total
boolean

Response · 200 · `DetailPage`

source
stringrequired
columns
object[]required
rows
object[]required
next_cursor
string | nullrequired
total
integer
total_truncated
boolean

GET /rest/v1.0/companies/{company_id}/analytics/report-links

List report links

v1.0Implemented

Parameters

company_id
integerpathrequired
status
stringquery

Response · 200 · `ReportLink[]`

id
integerrequired
title
stringrequired
target_type
stringrequired
target_id
integer | nullrequired
pack_key
string | nullrequired
project_id
integer | nullrequired
created_by
objectrequired
created_at
string (date-time)required
expires_at
string (date-time)required
revoked_at
string | null (date-time)required
revoke_reason
string | nullrequired
refresh
stringrequired
rendered_at
string (date-time)required
view_count
integerrequired
last_viewed_at
string | null (date-time)required
status
stringrequired

POST /rest/v1.0/companies/{company_id}/analytics/report-links

Publish a report link

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery

Request body

link
ReportLinkInputrequired

Response · 201 · `ReportLinkCreated`

id
integerrequired
title
stringrequired
target_type
stringrequired
target_id
integer | nullrequired
pack_key
string | nullrequired
project_id
integer | nullrequired
created_by
objectrequired
created_at
string (date-time)required
expires_at
string (date-time)required
revoked_at
string | null (date-time)required
revoke_reason
string | nullrequired
refresh
stringrequired
rendered_at
string (date-time)required
view_count
integerrequired
last_viewed_at
string | null (date-time)required
status
stringrequired
url
stringrequired
token
stringrequired

DELETE /rest/v1.0/companies/{company_id}/analytics/report-links/{id}

Revoke a report link

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `ReportLink`

id
integerrequired
title
stringrequired
target_type
stringrequired
target_id
integer | nullrequired
pack_key
string | nullrequired
project_id
integer | nullrequired
created_by
objectrequired
created_at
string (date-time)required
expires_at
string (date-time)required
revoked_at
string | null (date-time)required
revoke_reason
string | nullrequired
refresh
stringrequired
rendered_at
string (date-time)required
view_count
integerrequired
last_viewed_at
string | null (date-time)required
status
stringrequired

POST /rest/v1.0/companies/{company_id}/analytics/report-links/revoke-all

Revoke every report link

v1.0Implemented

Parameters

company_id
integerpathrequired

Response · 200 · `object`

revoked
integerrequired

GET /rest/v1.0/companies/{company_id}/analytics/schedules

List scheduled deliveries

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery
page
integerquery
per_page
integerquery

Response · 200 · `Schedule[]`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
target_type
stringrequired
target_id
integer | nullrequired
pack_key
string | nullrequired
filters
FilterStaterequired
format
stringrequired
cadence
stringrequired
hour
integerrequired
weekday
integer | nullrequired
monthday
integer | nullrequired
timezone
stringrequired
recipient_ids
integer[]required
enabled
booleanrequired
next_run_at
stringrequired
last_run_at
string | nullrequired
last_status
string | nullrequired
last_error
string | nullrequired
download_url
string | nullrequired
created_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired
burst
stringrequired
condition
ScheduleCondition | nullrequired
webhook
booleanrequired
view_id
integer | nullrequired

POST /rest/v1.0/companies/{company_id}/analytics/schedules

Create a scheduled delivery

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery

Request body

schedule
ScheduleInputrequired

Response · 201 · `Schedule`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
target_type
stringrequired
target_id
integer | nullrequired
pack_key
string | nullrequired
filters
FilterStaterequired
format
stringrequired
cadence
stringrequired
hour
integerrequired
weekday
integer | nullrequired
monthday
integer | nullrequired
timezone
stringrequired
recipient_ids
integer[]required
enabled
booleanrequired
next_run_at
stringrequired
last_run_at
string | nullrequired
last_status
string | nullrequired
last_error
string | nullrequired
download_url
string | nullrequired
created_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired
burst
stringrequired
condition
ScheduleCondition | nullrequired
webhook
booleanrequired
view_id
integer | nullrequired

GET /rest/v1.0/companies/{company_id}/analytics/schedules/{id}

Show a scheduled delivery

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 200 · `Schedule`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
target_type
stringrequired
target_id
integer | nullrequired
pack_key
string | nullrequired
filters
FilterStaterequired
format
stringrequired
cadence
stringrequired
hour
integerrequired
weekday
integer | nullrequired
monthday
integer | nullrequired
timezone
stringrequired
recipient_ids
integer[]required
enabled
booleanrequired
next_run_at
stringrequired
last_run_at
string | nullrequired
last_status
string | nullrequired
last_error
string | nullrequired
download_url
string | nullrequired
created_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired
burst
stringrequired
condition
ScheduleCondition | nullrequired
webhook
booleanrequired
view_id
integer | nullrequired

PATCH /rest/v1.0/companies/{company_id}/analytics/schedules/{id}

Update a scheduled delivery

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Request body

schedule
SchedulePatchrequired

Response · 200 · `Schedule`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
target_type
stringrequired
target_id
integer | nullrequired
pack_key
string | nullrequired
filters
FilterStaterequired
format
stringrequired
cadence
stringrequired
hour
integerrequired
weekday
integer | nullrequired
monthday
integer | nullrequired
timezone
stringrequired
recipient_ids
integer[]required
enabled
booleanrequired
next_run_at
stringrequired
last_run_at
string | nullrequired
last_status
string | nullrequired
last_error
string | nullrequired
download_url
string | nullrequired
created_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired
burst
stringrequired
condition
ScheduleCondition | nullrequired
webhook
booleanrequired
view_id
integer | nullrequired

DELETE /rest/v1.0/companies/{company_id}/analytics/schedules/{id}

Delete a scheduled delivery

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 204

No response body.

GET /rest/v1.0/companies/{company_id}/analytics/schedules/{id}/file

Download the file behind an analytics.schedule.delivered webhook

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired
token
stringqueryrequired

Response · 200 · `string (binary)`

No documented fields.

POST /rest/v1.0/companies/{company_id}/analytics/schedules/{id}/run

Deliver a schedule now

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Response · 202 · `ExportJob`

id
integerrequired
status
stringrequired
percent_complete
integerrequired
download_url
string | nullrequired
error
string | nullrequired

POST /rest/v1.0/companies/{company_id}/analytics/schedules/{id}/transfer

Transfer a schedule to a new owner (admin only)

v1.0Implemented

Parameters

company_id
integerpathrequired
id
integerpathrequired

Request body

owner_id
integerrequired

Response · 200 · `Schedule`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
target_type
stringrequired
target_id
integer | nullrequired
pack_key
string | nullrequired
filters
FilterStaterequired
format
stringrequired
cadence
stringrequired
hour
integerrequired
weekday
integer | nullrequired
monthday
integer | nullrequired
timezone
stringrequired
recipient_ids
integer[]required
enabled
booleanrequired
next_run_at
stringrequired
last_run_at
string | nullrequired
last_status
string | nullrequired
last_error
string | nullrequired
download_url
string | nullrequired
created_by_id
integerrequired
created_at
stringrequired
updated_at
stringrequired
burst
stringrequired
condition
ScheduleCondition | nullrequired
webhook
booleanrequired
view_id
integer | nullrequired

GET /rest/v1.0/companies/{company_id}/analytics/settings

Effective analytics settings

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery

Response · 200 · `Settings`

company_id
integerrequired
project_id
integer | nullrequired
settings
object[]required

PATCH /rest/v1.0/companies/{company_id}/analytics/settings

Update analytics settings (analytics admin)

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery

Request body

settings
objectrequired

Response · 200 · `Settings`

company_id
integerrequired
project_id
integer | nullrequired
settings
object[]required

GET /rest/v1.0/companies/{company_id}/analytics/story

Project Story (weekly brief or Today)

v1.0Implemented

Parameters

company_id
integerpathrequired
project_id
integerquery
horizon
stringquery
as_of
string (date)query

Response · 200 · `Story`

title
stringrequired
horizon
stringrequired
asOf
string (date)required
projectId
integerrequired
projectName
stringrequired
magnitude
numberrequired
sections
StorySection[]required

GET /rest/v1.0/projects/{project_id}/analytics/catalog

Catalog of metrics and dimensions readable by the caller (project)

v1.0Implemented

Parameters

project_id
integerpathrequired

Response · 200 · `Catalog`

metrics
object[]required
dimensions
object[]required
sources
object[]required
compat
objectrequired

GET /rest/v1.0/projects/{project_id}/analytics/dashboards

List dashboards (project)

v1.0Implemented

Parameters

project_id
integerpathrequired
filters[visibility]
stringquery
filters[certified]
booleanquery
filters[favorite]
booleanquery
page
integerquery
per_page
integerquery

Response · 200 · `Dashboard[]`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
pack_key
string | nullrequired
spec
DashboardSpecrequired
visibility
stringrequired
owner_id
integerrequired
certified
booleanrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
certified_by
integer | nullrequired
certified_at
string | nullrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

POST /rest/v1.0/projects/{project_id}/analytics/dashboards

Create a dashboard (project)

v1.0Implemented

Parameters

project_id
integerpathrequired

Request body

dashboard
DashboardInputrequired

Response · 201 · `Dashboard`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
pack_key
string | nullrequired
spec
DashboardSpecrequired
visibility
stringrequired
owner_id
integerrequired
certified
booleanrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
certified_by
integer | nullrequired
certified_at
string | nullrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

GET /rest/v1.0/projects/{project_id}/analytics/dashboards/{id}

Show a dashboard (project)

v1.0Implemented

Parameters

project_id
integerpathrequired
id
integerpathrequired

Response · 200 · `Dashboard`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
pack_key
string | nullrequired
spec
DashboardSpecrequired
visibility
stringrequired
owner_id
integerrequired
certified
booleanrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
certified_by
integer | nullrequired
certified_at
string | nullrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

PATCH /rest/v1.0/projects/{project_id}/analytics/dashboards/{id}

Update a dashboard (project)

v1.0Implemented

Parameters

project_id
integerpathrequired
id
integerpathrequired

Request body

dashboard
DashboardPatchrequired

Response · 200 · `Dashboard`

id
integerrequired
company_id
integerrequired
project_id
integer | nullrequired
name
stringrequired
description
string | nullrequired
pack_key
string | nullrequired
spec
DashboardSpecrequired
visibility
stringrequired
owner_id
integerrequired
certified
booleanrequired
favorite
booleanrequired
view_count
integerrequired
can_edit
booleanrequired
created_at
stringrequired
updated_at
stringrequired
certified_by
integer | nullrequired
certified_at
string | nullrequired
version
integerrequired
web_url
stringrequired
data_url
stringrequired
export_url
stringrequired

DELETE /rest/v1.0/projects/{project_id}/analytics/dashboards/{id}

Delete a dashboard (project)

v1.0Implemented

Parameters

project_id
integerpathrequired
id
integerpathrequired

Response · 204

No response body.

GET /rest/v1.0/projects/{project_id}/analytics/query

Run an analytics query (project, GET form)

v1.0Implemented

Parameters

project_id
integerpathrequired
q
stringqueryrequired
If-None-Match
stringheader

Response · 200 · `QueryResult`

columns
object[]required
rows
string | number | null[][]required
labels
objectrequired
totals
array | nullrequired
compare
object
truncated
booleanrequired
partial
object[]required
unavailable
object[]required
meta
objectrequired

POST /rest/v1.0/projects/{project_id}/analytics/query

Run an analytics query (project)

v1.0Implemented

Parameters

project_id
integerpathrequired

Request body

query
QuerySpecrequired

Response · 200 · `QueryResult`

columns
object[]required
rows
string | number | null[][]required
labels
objectrequired
totals
array | nullrequired
compare
object
truncated
booleanrequired
partial
object[]required
unavailable
object[]required
meta
objectrequired

POST /rest/v1.0/projects/{project_id}/analytics/query/detail

Records behind a result cell (project)

v1.0Implemented

Parameters

project_id
integerpathrequired

Request body

query
QuerySpecrequired
cell
object[]required
metric
string
cursor
string | null
columns
string[]
sort
object
limit
integer
total
boolean

Response · 200 · `DetailPage`

source
stringrequired
columns
object[]required
rows
object[]required
next_cursor
string | nullrequired
total
integer
total_truncated
boolean

Analytics audit trail (company admins only)

Parameters

Response · 200 · ActivityEvent[]

Content owned by inactive users (company admins only)

Parameters

Response · 200 · OrphanedItem[]

List KPI alert rules

Parameters

Response · 200 · AlertRule[]

Create a KPI alert rule

Parameters

Request body

Response · 201 · AlertRule

Show a KPI alert rule

Parameters

Response · 200 · AlertRule

Update a KPI alert rule

Parameters

Request body

Response · 200 · AlertRule

Delete a KPI alert rule

Parameters

Response · 204

Transfer an alert to a new owner (analytics admin only)

Parameters

Request body

Response · 200 · AlertRule

Answer a question with a governed query

Parameters

Request body

Response · 200 · AskAnswer

Catalog of metrics and dimensions readable by the caller (company)

Parameters

Response · 200 · Catalog

Where a metric or dimension key is used

Parameters

Response · 200 · Usage

A thread (oldest first)

Parameters

Response · 200 · Comment[]

Comment on a dashboard, exploration, insight or goal

Parameters

Request body

Response · 201 · Comment

Edit (author) or resolve / reopen (anyone who can open the target) a comment

Parameters

Request body

Response · 200 · Comment

Delete a comment (author, or analytics admin at the target's scope)

Parameters

Response · 204

People who can open the target (mention and assignee picker)

Parameters

Response · 200 · object[]

List dashboards (company)

Parameters

Response · 200 · Dashboard[]

Create a dashboard (company)

Parameters

Request body

Response · 201 · Dashboard

Show a dashboard (company)

Parameters

Response · 200 · Dashboard

Update a dashboard (company)

Parameters

Request body

Response · 200 · Dashboard

Delete a dashboard (company)

Parameters

Response · 204

Clone a dashboard into a new private copy

Parameters

Request body

Response · 201 · Dashboard

Get a dashboard's computed tile data (company)

Parameters

Response · 200 · DashboardData

Restore a deleted dashboard from trash (owner or analytics admin)

Parameters

Response · 200 · `ActivityEvent[]`

Response · 200 · `OrphanedItem[]`

Response · 200 · `AlertRule[]`

Response · 201 · `AlertRule`

Response · 200 · `AlertRule`

Response · 200 · `AlertRule`

Response · 200 · `AlertRule`

Response · 200 · `AskAnswer`

Response · 200 · `Catalog`

Response · 200 · `Usage`

Response · 200 · `Comment[]`

Response · 201 · `Comment`

Response · 200 · `Comment`

Response · 200 · `object[]`

Response · 200 · `Dashboard[]`

Response · 201 · `Dashboard`

Response · 200 · `Dashboard`

Response · 200 · `Dashboard`

Response · 201 · `Dashboard`

Response · 200 · `DashboardData`

Response · 200 · `Dashboard`

Response · 200 · `Revision[]`

Response · 200 · `Dashboard`

Response · 200 · `ShareList`

Response · 200 · `ShareList`

Response · 200 · `Dashboard`

Response · 200 · `SavedView[]`

Response · 201 · `SavedView`

Response · 200 · `SavedView`

Response · 200 · `SavedView`

Response · 200 · `object`

Response · 201 · `ValueGroup`

Response · 200 · `ValueGroup`

Response · 200 · `ValueGroup`

Response · 200 · `ValueGroup`

Response · 200 · `ValueGroup`

Response · 200 · `object`

Response · 200 · `Exploration[]`

Response · 201 · `Exploration`

Response · 200 · `Exploration`