Skip to content
Convor
Convor Docs
API ReferenceAnalytics

Get average CSAT rating bucketed by conversation first-response-time

Returns average CSAT ratings grouped by first-response-time buckets for rated conversations in the selected range.

GET/api/analytics/csat-by-frt

Returns average CSAT ratings grouped by first-response-time buckets for rated conversations in the selected range. Buckets cover fast replies, slower replies, and an unanswered bucket for conversations that never received an operator or AI response. When a bucket has no survey responses, avgRating is null and count is 0. To use custom dates, send both start and end as ISO 8601 datetimes with offsets. Explicit boundaries override range; a single boundary is rejected. Date buckets are calculated in UTC. Periods with no data return the documented empty or zero-value response. Endpoints that support format=csv return a text/csv download. CSV export may require an eligible plan; JSON is the default.

Endpoint requirements

Credentials
Use either Bearer API key or X-API-Key header.
Required scope
analytics:read
Module
Automation & API module (api_access)
Organization and site scope
Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
Retry behavior
Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.

Query Parameters

range?string

Query parameter. Range. Allowed values: 7d, 30d, 90d.

Default"30d"

Value in

  • "7d"
  • "30d"
  • "90d"
start?string

Query parameter. ISO 8601 date and time for start.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Formatdate-time
end?string

Query parameter. ISO 8601 date and time for end.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Formatdate-time
scope?"all"

Query parameter. Scope. Allowed values: all.

Value in

  • "all"
format?string

Query parameter. Format. Allowed values: json, csv.

Default"json"

Value in

  • "json"
  • "csv"

Header Parameters

X-Project-Id?|

DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

{  "scope": "single",  "scoreScale": "raw",  "buckets": [    {      "bucket": "<1m",      "avgRating": 2.9,      "count": 14    },    {      "bucket": "1-5m",      "avgRating": 2.7,      "count": 26    },    {      "bucket": "5-15m",      "avgRating": 2.4,      "count": 18    },    {      "bucket": "15-60m",      "avgRating": 2.1,      "count": 9    },    {      "bucket": ">60m",      "avgRating": 1.8,      "count": 3    },    {      "bucket": "unanswered",      "avgRating": null,      "count": 0    }  ],  "projectBreakdown": [    {      "projectId": "11111111-1111-4111-8111-111111111111",      "projectName": "Example name",      "ratingScale": "stars5",      "buckets": [        {          "bucket": "example",          "avgRating": 1,          "count": 1        }      ]    }  ]}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/analytics/csat-by-frt?format=json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/analytics/csat-by-frt?format=json", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

Get approximate visitor locations within a country

Returns aggregate, approximate city-level locations for visitors in one country during the selected analytics period.

Get average first-response-time and SLA-breach rate

Calculates the time from the first visitor message to the first operator reply for conversations in the selected range.

On this page

Request examplescurlJavaScript