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.

PATCH

api

accounts

{account_id}

analytics

drilldown_settings

Update analytics drilldown settings

curl --request PATCH \
  --url https://app.tied.com/api/v2/accounts/{account_id}/analytics/drilldown_settings \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "analytics_drilldown_extended_roles": [
    "agent"
  ]
}
'

import requests

url = "https://app.tied.com/api/v2/accounts/{account_id}/analytics/drilldown_settings"

payload = { "analytics_drilldown_extended_roles": ["agent"] }
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({analytics_drilldown_extended_roles: ['agent']})
};

fetch('https://app.tied.com/api/v2/accounts/{account_id}/analytics/drilldown_settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://app.tied.com/api/v2/accounts/{account_id}/analytics/drilldown_settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"analytics_drilldown_extended_roles\": [\n    \"agent\"\n  ]\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.tied.com/api/v2/accounts/{account_id}/analytics/drilldown_settings"

	payload := strings.NewReader("{\n  \"analytics_drilldown_extended_roles\": [\n    \"agent\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("api_access_token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "analyticsDrilldownExtendedRoles": [
    "agent"
  ],
  "extendableRoles": [
    "agent",
    "manager"
  ]
}

{
  "error": {
    "code": "multiple_credentials"
  }
}

{
  "error": "Resource could not be found"
}

{
  "error": "trial_expired_locked",
  "message": "This workspace trial has ended. Restore billing from the billing page to continue."
}

{
  "error": "Resource could not be found"
}

{
  "error": "Resource could not be found"
}

{
  "error": "<string>",
  "retryAfter": 123
}

{
  "error": "Resource could not be found"
}

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

integer

required

The numeric ID of the account

Body

application/json

analytics_drilldown_extended_roles

enum<string>[]

required

Distinct roles extended to REDACTED access; empty means no extension.

Maximum array length: 2

Available options:

agent,

manager

Response

Success.

analyticsDrilldownExtendedRoles

enum<string>[]

required

Distinct roles extended to REDACTED access; empty means no extension.

Maximum array length: 2

Available options:

agent,

manager

extendableRoles

enum<string>[]

required

Roles eligible for extension.

Available options:

agent,

manager

Update analytics drilldown settings

curl --request PATCH \
  --url https://app.tied.com/api/v2/accounts/{account_id}/analytics/drilldown_settings \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "analytics_drilldown_extended_roles": [
    "agent"
  ]
}
'

import requests

url = "https://app.tied.com/api/v2/accounts/{account_id}/analytics/drilldown_settings"

payload = { "analytics_drilldown_extended_roles": ["agent"] }
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({analytics_drilldown_extended_roles: ['agent']})
};

fetch('https://app.tied.com/api/v2/accounts/{account_id}/analytics/drilldown_settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://app.tied.com/api/v2/accounts/{account_id}/analytics/drilldown_settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"analytics_drilldown_extended_roles\": [\n    \"agent\"\n  ]\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.tied.com/api/v2/accounts/{account_id}/analytics/drilldown_settings"

	payload := strings.NewReader("{\n  \"analytics_drilldown_extended_roles\": [\n    \"agent\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("api_access_token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "analyticsDrilldownExtendedRoles": [
    "agent"
  ],
  "extendableRoles": [
    "agent",
    "manager"
  ]
}

{
  "error": {
    "code": "multiple_credentials"
  }
}

{
  "error": "Resource could not be found"
}

{
  "error": "trial_expired_locked",
  "message": "This workspace trial has ended. Restore billing from the billing page to continue."
}

{
  "error": "Resource could not be found"
}

{
  "error": "Resource could not be found"
}

{
  "error": "<string>",
  "retryAfter": 123
}

{
  "error": "Resource could not be found"
}

Getting started

Conversations

Contacts

Inboxes and channels

Automation and routing

Reporting

Help Center

Account and access

Orchestration Studio

Billing

Client API

Widget API

Receiving webhooks

Update analytics drilldown settings

Authorizations

Path Parameters

Body

Response