Skip to main content
GET
Topic labeling health

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

Query Parameters

weeks
integer
default:12

Coverage and correction window in calendar weeks.

Required range: 1 <= x <= 26
backlog_days
integer
default:90

Unlabeled age window in days.

Required range: 1 <= x <= 365

Response

Actual synthetic request response; see topic analytics evidence.

All five health panels; does not require Topics to be enabled.

window
object
required

Effective coverage and backlog windows.

coverage
object
required

Weekly and total main-topic coverage.

backlog
object
required

Unlabeled conversations in the backlog window.

agents
object[]
required

At most 100 people, ordered by set count descending then user ID.

Maximum array length: 100
teams
object[]
required

Top 100 teams by conversation count, then no-team, then optional overflow; totals include all conversations.

Maximum array length: 102
sources
object
required

Who assigned the current main topics.