> ## Documentation Index > Fetch the complete documentation index at: https://docs.tied.com/llms.txt > Use this file to discover all available pages before exploring further. # Topic readiness > Read-only readiness through Current.account. Requires account membership and ReportPolicy view access (administrator in the open-code policy). State precedence: not_on when no settings or disabled; low_volume below 30 conversations; learning below 50 labeled; partial below 0.5 coverage; otherwise ok. Missing settings or disabled Topics returns HTTP 200 with not_on and actual counts. Empty periods have zero counts, null coverage and remaining 50. Explicit until includes its final fractional second. Included inbox restrictions apply. ## OpenAPI ````yaml /api-reference/openapi.json get /api/v2/accounts/{account_id}/topics/readiness openapi: 3.0.4 info: title: Tied API description: >- The Tied REST API. Three families of endpoint, each with its own credential: **Application** for everything inside an account, **Platform** for provisioning accounts and users, and **Client** for acting as a contact from your own surface. version: 1.1.0 termsOfService: https://tied.com/legal contact: email: hello@tied.com license: name: MIT License url: https://opensource.org/licenses/MIT servers: - url: https://app.tied.com description: Tied cloud security: [] tags: - name: Account AgentBots description: Account-specific Agent Bots - name: Agents description: Agent management APIs - name: Canned Responses description: Pre-defined responses for common queries - name: Contacts description: Contact management APIs - name: Contact Labels description: Manage contact labels - name: Conversation Assignments description: Manage conversation assignments - name: Conversation Labels description: Manage conversation labels - name: Conversations description: Conversation management APIs - name: Custom Attributes description: Custom fields for contacts and conversations - name: Custom Filters description: Saved filters for conversations - name: Inboxes description: Communication channels setup - name: Integrations description: Third-party integrations - name: Messages description: Message management APIs - name: Profile description: User profile APIs - name: Reports description: Analytics and reporting APIs - name: Teams description: Team management APIs - name: Webhooks description: Event notification webhooks - name: Automation Rule description: Workflow automation rules - name: Help Center description: Knowledge base management - name: Contacts API description: Public contact APIs - name: Conversations API description: Public conversation APIs - name: Messages API description: Public message APIs - name: CSAT Survey Page description: Customer satisfaction survey - name: Account description: >- The authenticated user's own account — read and update account settings. Distinct from the Platform family's **Accounts**, which provisions accounts across an installation. - name: Audit Logs description: Read the account's audit trail - name: Inbox API description: Public inbox lookup by channel identifier - name: Labels description: >- Create and manage the account's labels. Applying one to a conversation or contact is a separate endpoint under those resources. - name: Macros description: >- Saved multi-step actions an agent — or an integration — can run against one or more conversations. - name: Campaigns description: Ongoing website campaigns and one-off SMS and WhatsApp sends. - name: Contact Notes description: Internal notes on a contact. Never visible to the contact. - name: Help Center Categories description: Categories group a portal's articles, one tree per allowed locale. - name: Help Center Articles description: The articles a portal publishes, and their draft and archived states. - name: Summary Reports description: Per-agent, per-team, per-inbox and per-label totals for a period, as JSON. - name: Live Reports description: Right-now queue counts. No date range — these describe the present. - name: CSAT description: >- The satisfaction ratings contacts have submitted, and the metrics computed from them. - name: Notifications description: >- The per-user notification feed, its read and snooze state, and the settings that decide what lands in it. - name: Conversation Participants description: >- The agents watching a conversation. Participants get notified about it without being assigned to it. - name: Draft Messages description: >- The unsent reply held for a conversation. Stored in Redis, one per conversation. - name: Search description: >- One search service across conversations, contacts, messages and Help Center articles. - name: Dashboard Apps description: Embedded pages that appear as a tab beside a conversation. - name: Assignment Policies description: How conversations are handed out, and which inbox uses which policy. - name: Files description: Storing a file so another endpoint can attach it. - name: Bot Flows description: >- Scripted conversation flows, their versions, and the publish and rollback that move between them. - name: Billing description: >- Credit balance, usage, invoices, spend controls and the provider-hosted payment flows. - name: AMB Templates description: >- Saved Apple Messages primitive payloads an agent can reuse from the composer. - name: AMB Onboarding description: The in-flight Apple Messages for Business registration for an account. - name: Widget Session description: Starting a widget session and reading the visitor it belongs to. - name: Widget Conversation description: The visitor's conversation and its messages. - name: Widget Context description: Campaigns, agents, labels, events and uploads for a widget session. - name: CSAT Survey description: The public, unauthenticated survey a contact answers from a link. - name: Workspace description: Scheduling and cancelling deletion of the whole workspace. - name: Widget Integrations description: Provider actions available to a visitor session in its own conversation. - name: Orchestration Studio description: >- Administrator-only read APIs for Orchestration Studio cases and knowledge sources. - name: Topic Analytics description: Account Topics readiness, labeling health and usage aggregates. - name: Analytics V2 description: >- Account-scoped metrics, anonymized benchmarks and audited conversation drilldown. paths: /api/v2/accounts/{account_id}/topics/readiness: parameters: - $ref: '#/components/parameters/account_id' get: tags: - Topic Analytics summary: Topic readiness description: >- Read-only readiness through Current.account. Requires account membership and ReportPolicy view access (administrator in the open-code policy). State precedence: not_on when no settings or disabled; low_volume below 30 conversations; learning below 50 labeled; partial below 0.5 coverage; otherwise ok. Missing settings or disabled Topics returns HTTP 200 with not_on and actual counts. Empty periods have zero counts, null coverage and remaining 50. Explicit until includes its final fractional second. Included inbox restrictions apply. operationId: get-topic-readiness parameters: - name: since in: query description: Start Unix epoch seconds; defaults to 30 days before until. schema: type: integer - name: until in: query description: >- End Unix epoch seconds; defaults to now. since must precede until; maximum 366 days. schema: type: integer responses: '200': description: Actual synthetic request response; see topic analytics evidence. content: application/json: schema: $ref: '#/components/schemas/topic_readiness' example: state: low_volume conversations: 2 labeled: 1 coverage: 0.5 thresholds: lowVolume: 30 learning: 50 partialCoverage: 0.5 remaining: 49 period: since: 1788782400 until: 1791374400 x-example-provenance: source: spec/contract/topic_analytics_spec.rb capture: >- Actual synthetic Rails integration response; full Content-Type and scrub details in docs/platform-api/topic-analytics-evidence/responses.json. scrubbed: true '400': description: >- The request presented both a Devise Token Auth session credential and an api_access_token. The request is refused before the action runs. content: application/json: schema: type: object required: - error properties: error: type: object required: - code properties: code: type: string enum: - multiple_credentials additionalProperties: false additionalProperties: false example: error: code: multiple_credentials '401': description: >- Unauthenticated or account is not accessible to the caller. Devise authentication responses may use an `errors` array; account access denials use `error`. content: application/json: schema: oneOf: - $ref: '#/components/schemas/error_message' - type: object required: - errors properties: errors: type: array items: type: string '422': description: Invalid period, window, grouping, metric, pagination or version. content: application/json: schema: $ref: '#/components/schemas/error_message' security: - userApiKey: [] components: parameters: account_id: in: path name: id schema: type: integer required: true description: The numeric ID of the account schemas: topic_readiness: type: object description: Account Topics report readiness; counts remain available when disabled. required: - state - conversations - labeled - coverage - remaining - thresholds - period properties: state: type: string description: >- First matching readiness state: disabled, low volume, learning, partial coverage, or ready. enum: - not_on - low_volume - learning - partial - ok conversations: type: integer description: Conversations created in the window. minimum: 0 labeled: type: integer description: Conversations with a current, non-superseded rank 1 topic. minimum: 0 coverage: type: number description: >- Labeled / conversations rounded to four decimals; null with zero conversations. nullable: true minimum: 0 maximum: 1 remaining: type: integer description: max(50 minus labeled, 0), even when disabled. minimum: 0 thresholds: type: object description: Readiness thresholds. required: - lowVolume - learning - partialCoverage properties: lowVolume: type: integer description: Low-volume threshold, 30 conversations. minimum: 0 learning: type: integer description: Learning threshold, 50 labeled conversations. minimum: 0 partialCoverage: type: number description: Partial threshold, 0.5. nullable: true minimum: 0 maximum: 1 period: type: object description: Effective period; defaults to the last 30 days. required: - since - until properties: since: type: integer description: Inclusive start Unix epoch seconds. until: type: integer description: >- End Unix epoch seconds; an explicit until includes its whole second. error_message: type: object description: >- The shape returned by `render_unauthorized`, `render_not_found_error` and `render_could_not_create_error`. properties: error: type: string description: A single human-readable message. example: Resource could not be found required: - error securitySchemes: userApiKey: type: apiKey in: header name: api_access_token description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.