Agent summary report - Tied

GET

/

api

/

v2

/

accounts

/

{account_id}

/

summary_reports

/

agent

Agent summary report

curl --request GET \
  --url https://app.tied.com/api/v2/accounts/{account_id}/summary_reports/agent \
  --header 'api_access_token: <api-key>'

import requests

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

headers = {"api_access_token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};

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

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

request = Net::HTTP::Get.new(url)
request["api_access_token"] = '<api-key>'

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_access_token", "<api-key>")

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

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

	fmt.Println(string(body))

}

[
  {
    "id": 1,
    "conversations_count": 10,
    "resolved_conversations_count": 0,
    "avg_resolution_time": null,
    "avg_first_response_time": null,
    "avg_reply_time": null
  }
]

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

id

integer

required

The numeric ID of the account

Query Parameters

since

string

required

Start of the reporting period, as Unix epoch seconds. Required.

Example:

"1787369963"

until

string

required

End of the reporting period, as Unix epoch seconds. Required.

Example:

"1789961963"

business_hours

boolean

Measure the time metrics against the inbox's configured business hours instead of wall-clock time.

Response

Success

id

integer

The agent, team, inbox or label this row is for.

name

string

Present on the label report only; the other three identify the row by id alone.

conversations_count

integer

Conversations in the period.

resolved_conversations_count

integer

How many of them were resolved.

avg_resolution_time

number | null

Mean seconds from first message to resolution.

avg_first_response_time

number | null

Mean seconds to the first agent reply.

avg_reply_time

number | null

Mean seconds between a contact message and the agent reply that followed it.

incoming_messages_count

integer

Inbox report only — messages received.

outgoing_messages_count

integer

Inbox report only — messages sent.

Agent summary report

curl --request GET \
  --url https://app.tied.com/api/v2/accounts/{account_id}/summary_reports/agent \
  --header 'api_access_token: <api-key>'

import requests

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

headers = {"api_access_token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};

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

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

request = Net::HTTP::Get.new(url)
request["api_access_token"] = '<api-key>'

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_access_token", "<api-key>")

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

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

	fmt.Println(string(body))

}

[
  {
    "id": 1,
    "conversations_count": 10,
    "resolved_conversations_count": 0,
    "avg_resolution_time": null,
    "avg_first_response_time": null,
    "avg_reply_time": null
  }
]

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