Batch analytics metrics

Authenticated account members only; administrators or a custom role with report_manage may read metrics and benchmarks. Ordinary agents/managers get 403; foreign or nonexistent accounts get 401. Reads are scoped through Current.account. At most 25 distinct ids. HTTP 200 contains metrics keyed by requested id, including partial failures: per-item 404 unknown metric, 422 invalid dimensions/grain, 503 unavailable, or 500 unexpected failure. Malformed shared dates/fields, duplicate ids and invalid list shapes fail the entire request with 422.

POST

api

accounts

{account_id}

analytics

metrics

batch

Batch analytics metrics

curl --request POST \
  --url https://app.tied.com/api/v2/accounts/{account_id}/analytics/metrics/batch \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "since": "2026-10-01",
  "until": "2026-10-07",
  "metrics": [
    {
      "id": "conversation_volume",
      "dimensions": [
        "time"
      ]
    },
    {
      "id": "unknown_metric"
    }
  ]
}
'

import requests

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

payload = {
    "since": "2026-10-01",
    "until": "2026-10-07",
    "metrics": [{
            "id": "conversation_volume",
            "dimensions": ["time"]
        }, { "id": "unknown_metric" }]
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    since: '2026-10-01',
    until: '2026-10-07',
    metrics: [{id: 'conversation_volume', dimensions: ['time']}, {id: 'unknown_metric'}]
  })
};

fetch('https://app.tied.com/api/v2/accounts/{account_id}/analytics/metrics/batch', 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/metrics/batch")

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

request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"since\": \"2026-10-01\",\n  \"until\": \"2026-10-07\",\n  \"metrics\": [\n    {\n      \"id\": \"conversation_volume\",\n      \"dimensions\": [\n        \"time\"\n      ]\n    },\n    {\n      \"id\": \"unknown_metric\"\n    }\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/metrics/batch"

	payload := strings.NewReader("{\n  \"since\": \"2026-10-01\",\n  \"until\": \"2026-10-07\",\n  \"metrics\": [\n    {\n      \"id\": \"conversation_volume\",\n      \"dimensions\": [\n        \"time\"\n      ]\n    },\n    {\n      \"id\": \"unknown_metric\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", 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))

}

{
  "metrics": {
    "conversation_volume": {
      "metricId": "conversation_volume",
      "unit": "count",
      "pending": false,
      "lockOnBillingClose": false,
      "value": 3,
      "delta": 0,
      "spark": [
        3,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ],
      "series": {
        "categories": [
          "1",
          "2",
          "3",
          "4",
          "5",
          "6",
          "7"
        ],
        "categoryDates": [
          "2026-10-01",
          "2026-10-02",
          "2026-10-03",
          "2026-10-04",
          "2026-10-05",
          "2026-10-06",
          "2026-10-07"
        ],
        "data": [
          0,
          0,
          0,
          0,
          0,
          0,
          0
        ]
      }
    },
    "unknown_metric": {
      "error": {
        "status": 404,
        "message": "Unknown metric"
      }
    }
  }
}

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

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

{
  "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

metrics

object[]

required

Unique metric ids, 1–25 entries. Shared malformed fields fail the whole request; metric-specific errors affect that entry only.

Required array length: 1 - 25 elements

Show child attributes

since

string<date>

Inclusive start date; default is 29 days before until.

until

string<date>

Inclusive last date; defaults to today in timezone. Maximum range 366 days and 800 buckets.

granularity

enum<string>

Must be supported by each metric; defaults to day if supported, otherwise its first grain.

Available options:

hour,

day,

week,

month

timezone

string

IANA time zone; default UTC.

business_hours

boolean

Legacy basis flag, mutually exclusive with hours.

hours

enum<string>

Hours basis; business/off require analytics_business_hours. Mutually exclusive with business_hours.

Available options:

all,

business,

off

compare

boolean

Include aligned prior-window comparisons when supported.

topic_mentions

enum<string>

Count main topic only (default) or all topic mentions.

Available options:

main,

all

Response

Success.

metrics

object

required

One entry keyed by each requested id, including unknown ids. Successful, pending and failed entries may coexist.

Show child attributes

Batch analytics metrics

curl --request POST \
  --url https://app.tied.com/api/v2/accounts/{account_id}/analytics/metrics/batch \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "since": "2026-10-01",
  "until": "2026-10-07",
  "metrics": [
    {
      "id": "conversation_volume",
      "dimensions": [
        "time"
      ]
    },
    {
      "id": "unknown_metric"
    }
  ]
}
'

import requests

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

payload = {
    "since": "2026-10-01",
    "until": "2026-10-07",
    "metrics": [{
            "id": "conversation_volume",
            "dimensions": ["time"]
        }, { "id": "unknown_metric" }]
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    since: '2026-10-01',
    until: '2026-10-07',
    metrics: [{id: 'conversation_volume', dimensions: ['time']}, {id: 'unknown_metric'}]
  })
};

fetch('https://app.tied.com/api/v2/accounts/{account_id}/analytics/metrics/batch', 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/metrics/batch")

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

request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"since\": \"2026-10-01\",\n  \"until\": \"2026-10-07\",\n  \"metrics\": [\n    {\n      \"id\": \"conversation_volume\",\n      \"dimensions\": [\n        \"time\"\n      ]\n    },\n    {\n      \"id\": \"unknown_metric\"\n    }\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/metrics/batch"

	payload := strings.NewReader("{\n  \"since\": \"2026-10-01\",\n  \"until\": \"2026-10-07\",\n  \"metrics\": [\n    {\n      \"id\": \"conversation_volume\",\n      \"dimensions\": [\n        \"time\"\n      ]\n    },\n    {\n      \"id\": \"unknown_metric\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", 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))

}

{
  "metrics": {
    "conversation_volume": {
      "metricId": "conversation_volume",
      "unit": "count",
      "pending": false,
      "lockOnBillingClose": false,
      "value": 3,
      "delta": 0,
      "spark": [
        3,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ],
      "series": {
        "categories": [
          "1",
          "2",
          "3",
          "4",
          "5",
          "6",
          "7"
        ],
        "categoryDates": [
          "2026-10-01",
          "2026-10-02",
          "2026-10-03",
          "2026-10-04",
          "2026-10-05",
          "2026-10-06",
          "2026-10-07"
        ],
        "data": [
          0,
          0,
          0,
          0,
          0,
          0,
          0
        ]
      }
    },
    "unknown_metric": {
      "error": {
        "status": 404,
        "message": "Unknown metric"
      }
    }
  }
}

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

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

{
  "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

Batch analytics metrics

Authorizations

Path Parameters

Body

Response