CSAT metrics - Tied

GET

/

api

/

v1

/

accounts

/

{account_id}

/

csat_survey_responses

/

metrics

CSAT metrics

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

import requests

url = "https://app.tied.com/api/v1/accounts/{account_id}/csat_survey_responses/metrics"

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/v1/accounts/{account_id}/csat_survey_responses/metrics', 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/v1/accounts/{account_id}/csat_survey_responses/metrics")

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/v1/accounts/{account_id}/csat_survey_responses/metrics"

	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))

}

{
  "total_count": 4,
  "ratings_count": {
    "2": 1,
    "4": 1,
    "5": 2
  },
  "total_sent_messages_count": 4
}

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

Start of the period, as Unix epoch seconds.

until

string

End of the period, as Unix epoch seconds.

user_ids

string

Restrict to responses on conversations assigned to these agents.

inbox_id

integer

Restrict to one inbox.

team_id

integer

Restrict to one team.

rating

integer

Restrict to one score, 1 to 5.

Response

Success

total_count

integer

Responses received in the period.

ratings_count

object

How many responses gave each score, keyed by the score as a string. Scores nobody gave are absent rather than zero.

Show child attributes

total_sent_messages_count

integer

Surveys sent in the period. Divide total_count by this for the response rate.

CSAT metrics

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

import requests

url = "https://app.tied.com/api/v1/accounts/{account_id}/csat_survey_responses/metrics"

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/v1/accounts/{account_id}/csat_survey_responses/metrics', 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/v1/accounts/{account_id}/csat_survey_responses/metrics")

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/v1/accounts/{account_id}/csat_survey_responses/metrics"

	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))

}

{
  "total_count": 4,
  "ratings_count": {
    "2": 1,
    "4": 1,
    "5": 2
  },
  "total_sent_messages_count": 4
}

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