Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List call analyses

Returns the phone system’s call analyses, newest first (ordered by createdAt descending with id as the tiebreak, so paging is deterministic). A call.analysis.completed webhook carries both callSid and callLogId — filter by either identifier to fetch that call’s analysis, or bound the list with an inclusive createdAt window (dateFrom/dateTo). Requires the calls scope.

GET/customer/phone-systems/{phoneSystemId}/call-analyses
Authorization
X-API-KeyAPI key · headerrequired
API key (sk_phones_* prefix) for programmatic access
Path parameters
phoneSystemIdstring<uuid>required
Phone system identifier, discoverable via the accessible phone systems operation.
Query parameters
pageinteger
1-indexed page number.
min 1 · default: 1
pageSizeinteger
Rows per page; at most 100.
min 1 · max 100 · default: 25
dateFromstring<date-time>
Inclusive lower bound (ISO 8601 UTC) on the row creation time.
dateTostring<date-time>
Inclusive upper bound (ISO 8601 UTC) on the row creation time.
callSidstring
Exact-match filter on the call identifier from a webhook payload.
min length 1 · max length 64
callLogIdstring<uuid>
Filter on the call log identifier from a webhook payload.
Responses
200One page of call analyses with the total row count for the filter.
dataobject[]required
Show properties
Array of object
analyzedAtstring<date-time> | anyrequired
When the analysis completed.
Show properties
Any of:
string<date-time>
string<date-time>
any
any
callLogIdstring<uuid>required
Analyzed call log — the callLogId carried by webhook payloads.
callSidstringrequired
Call identifier of the analyzed call, as delivered in webhook payloads.
coachingTipsstring[]required
Actionable coaching suggestions from the analysis.
createdAtstring<date-time>required
When the row was created; lists are ordered by this, descending.
idstring<uuid>required
Call analysis identifier.
overallScorenumber | anyrequired
Overall score (0-100); null until the analysis completes.
Show properties
Any of:
number
number
any
any
phoneSystemIdstring<uuid>required
Phone system the analyzed call belongs to.
statusstringrequired
Analysis lifecycle status.
Allowed:pendingprocessingcompletedfailed
pageintegerrequired
min 1
pageSizeintegerrequired
min 1 · max 100
totalintegerrequired
min 0
totalPagesintegerrequired
min 0
400Validation failure: an unknown query parameter, a malformed date or UUID, or a pageSize above 100. Field problems are itemized in errors[].
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
401The API key is missing, malformed, expired, or revoked.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
403The key lacks the calls:read scope, or is not a tenant API key.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
404The phone system does not exist or is not covered by the key.
codestringrequired
Stable machine identifier to branch on.
correlationIdstringrequired
Request identifier to quote to support.
detailstringrequired
User-safe explanation. Display it if you must; never match on it.
errorsobject[]
Field-level validation problems. Present on validation failures.
Show properties
Array of object
codestringrequired
Per-field machine code (REQUIRED, TOO_SMALL, …).
detailstringrequired
Human-readable description of the field problem.
pointerstringrequired
JSON Pointer to the offending request field.
paramsobject
Extra primitive detail about the condition, such as a limit that was hit.
retry_afterinteger
Seconds to wait before retrying, when a meaningful delay exists.
retryablebooleanrequired
Whether this condition is transient. Derived from code.
statusintegerrequired
Mirrors the HTTP status code.
titlestringrequired
Short human summary of the problem type.
typestringrequired
URL identifying the problem type. An identifier to match, not a link.
Request
curl -X GET "https://api.steerphones.com/v1/customer/phone-systems/%3Cuuid%3E/call-analyses" \
  -H "X-API-Key: YOUR_API_KEY"
Response
{
  "data": [
    {
      "analyzedAt": "2024-01-01T00:00:00Z",
      "callLogId": "<uuid>",
      "callSid": "string",
      "coachingTips": [
        "string"
      ],
      "createdAt": "2024-01-01T00:00:00Z",
      "id": "<uuid>",
      "overallScore": 0,
      "phoneSystemId": "<uuid>",
      "status": "pending"
    }
  ],
  "page": 0,
  "pageSize": 0,
  "total": 0,
  "totalPages": 0
}