> ## 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. # Update analytics drilldown settings > Authorization setting, administrator-only: report_manage alone is insufficient. Changes replace the full distinct agent/manager role list; [] revokes all extended access. Extended members receive redacted access only. Every call emits an Analytics::AccessLogSubscriber access notification, including refused and throttled calls. Durable Analytics::DrilldownAuditEvent rows are separate: list_view and detail_view on successful reads, setting_change with old/new roles on settings updates. Refusals, validation failures, unknown/foreign conversation ids and settings GET do not create durable rows. Audit write failure returns 503 before personal data is loaded; a settings write and its audit row commit or roll back together. All drilldown/settings responses are private, no-store, without ETag. ## OpenAPI ````yaml /api-reference/openapi.json patch /api/v2/accounts/{account_id}/analytics/drilldown_settings 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}/analytics/drilldown_settings: parameters: - $ref: '#/components/parameters/account_id' patch: tags: - Analytics V2 summary: Update analytics drilldown settings description: >- Authorization setting, administrator-only: report_manage alone is insufficient. Changes replace the full distinct agent/manager role list; [] revokes all extended access. Extended members receive redacted access only. Every call emits an Analytics::AccessLogSubscriber access notification, including refused and throttled calls. Durable Analytics::DrilldownAuditEvent rows are separate: list_view and detail_view on successful reads, setting_change with old/new roles on settings updates. Refusals, validation failures, unknown/foreign conversation ids and settings GET do not create durable rows. Audit write failure returns 503 before personal data is loaded; a settings write and its audit row commit or roll back together. All drilldown/settings responses are private, no-store, without ETag. operationId: update-analytics-v2-drilldown-settings requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/analytics_v2_settings_request' example: analytics_drilldown_extended_roles: - agent responses: '200': description: Success. content: application/json: schema: $ref: '#/components/schemas/analytics_v2_settings' example: analyticsDrilldownExtendedRoles: - agent extendableRoles: - agent - manager headers: Cache-Control: description: Every response is private and no-store. schema: type: string x-example-provenance: capture_file: >- docs/platform-api/analytics-v2-evidence/update-analytics-v2-drilldown-settings-default.json content_type: application/json; charset=utf-8 synthetic: true 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 headers: Cache-Control: description: Every response is private and no-store. schema: type: string '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 headers: Cache-Control: description: Every response is private and no-store. schema: type: string '402': description: >- The account trial has expired and the workspace is locked. Restore billing before changing analytics drilldown settings. content: application/json: schema: type: object required: - error - message properties: error: type: string description: Stable trial-lock refusal code. enum: - trial_expired_locked message: type: string description: >- Explains that billing must be restored before settings can change. example: error: trial_expired_locked message: >- This workspace trial has ended. Restore billing from the billing page to continue. headers: Cache-Control: description: Every response is private and no-store. schema: type: string '403': description: >- The role or AnalyticsDrilldownGuard refuses the caller; no conversation content is returned. content: application/json: schema: $ref: '#/components/schemas/error_message' headers: Cache-Control: description: Every response is private and no-store. schema: type: string '422': description: Malformed or unsupported input. content: application/json: schema: $ref: '#/components/schemas/error_message' headers: Cache-Control: description: Every response is private and no-store. schema: type: string '429': description: >- Account analytics budget exhausted. Retry-After is seconds until reset. headers: Retry-After: schema: type: string pattern: ^[0-9]+$ description: Seconds until reset. Cache-Control: description: Every response is private and no-store. schema: type: string content: application/json: schema: type: object required: - error - retryAfter properties: error: type: string description: Rate-limit message. retryAfter: type: integer description: Seconds until retry. additionalProperties: false '503': description: >- Analytics or durable audit is unavailable. Drilldown fails closed without personal data. content: application/json: schema: $ref: '#/components/schemas/error_message' headers: Cache-Control: description: Every response is private and no-store. schema: type: string security: - userApiKey: [] components: parameters: account_id: in: path name: id schema: type: integer required: true description: The numeric ID of the account schemas: analytics_v2_settings_request: type: object required: - analytics_drilldown_extended_roles properties: analytics_drilldown_extended_roles: type: array description: >- Distinct roles extended to REDACTED access; empty means no extension. items: type: string enum: - agent - manager uniqueItems: true maxItems: 2 analytics_v2_settings: type: object required: - analyticsDrilldownExtendedRoles - extendableRoles properties: analyticsDrilldownExtendedRoles: type: array description: >- Distinct roles extended to REDACTED access; empty means no extension. items: type: string enum: - agent - manager uniqueItems: true maxItems: 2 extendableRoles: type: array description: Roles eligible for extension. items: type: string enum: - agent - manager additionalProperties: false 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.