Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get call log report dimensions

Returns current display values for exactly the call groups, extensions, representatives, and category and sentiment definitions that retained report rows still reference. Report rows keep stable IDs and codes forever, so this is how a rename reaches a client without rewriting history. Membership is derived from retained calls, never from tenant configuration, so unused inventory is neither queried nor published, and nothing describing how the phone system is configured appears at all. Semantics are replace-all for that membership: an item missing from a later snapshot was deleted or is no longer referenced and should be dropped from your lookup, while a referenced but deactivated item stays and carries its status. This is a reporting projection, not the separately scoped Call Group or Extension resources. Requires a tenant-wide calls grant.

GET/customer/phone-systems/{phoneSystemId}/call-log-reports/dimensions
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.
Responses
200The report-scoped dimensions snapshot taken at generatedAt.
callGroupsobject[]required
Call groups referenced by retained report rows, ordered by id.
Show properties
Array of object
idstring<uuid>required
Stable identifier report rows reference.
namestringrequired
Current display name.
numberstring | anyrequired
Dialable number, when the resource has one.
Show properties
Any of:
string
string
any
any
statusstringrequired
Lifecycle state (active, inactive).
updatedAtstring<date-time>required
When the underlying record last changed.
categoriesobject[]required
Call category definitions referenced by retained report rows, ordered by code.
Show properties
Array of object
codestringrequired
Stable code report rows reference.
labelstringrequired
Current effective label for the code.
scorenumber | anyrequired
Aggregation score, for taxonomies that carry one; null otherwise.
Show properties
Any of:
number
number
any
any
sourcestringrequired
Which definition won: this phone system’s override, the global default, or the deterministic fallback derived from the code itself.
Allowed:phone_system_overrideglobal_defaultfallback
statusstring | anyrequired
Lifecycle state of the winning definition; null for a fallback, which owns no row.
Show properties
Any of:
string
string
any
any
updatedAtstring<date-time> | anyrequired
When the winning definition last changed; null for a fallback.
Show properties
Any of:
string<date-time>
string<date-time>
any
any
customerSentimentsobject[]required
Customer sentiment definitions referenced by retained report rows, ordered by code.
Show properties
Array of object
codestringrequired
Stable code report rows reference.
labelstringrequired
Current effective label for the code.
scorenumber | anyrequired
Aggregation score, for taxonomies that carry one; null otherwise.
Show properties
Any of:
number
number
any
any
sourcestringrequired
Which definition won: this phone system’s override, the global default, or the deterministic fallback derived from the code itself.
Allowed:phone_system_overrideglobal_defaultfallback
statusstring | anyrequired
Lifecycle state of the winning definition; null for a fallback, which owns no row.
Show properties
Any of:
string
string
any
any
updatedAtstring<date-time> | anyrequired
When the winning definition last changed; null for a fallback.
Show properties
Any of:
string<date-time>
string<date-time>
any
any
employeeSentimentsobject[]required
Employee sentiment definitions referenced by retained report rows, ordered by code.
Show properties
Array of object
codestringrequired
Stable code report rows reference.
labelstringrequired
Current effective label for the code.
scorenumber | anyrequired
Aggregation score, for taxonomies that carry one; null otherwise.
Show properties
Any of:
number
number
any
any
sourcestringrequired
Which definition won: this phone system’s override, the global default, or the deterministic fallback derived from the code itself.
Allowed:phone_system_overrideglobal_defaultfallback
statusstring | anyrequired
Lifecycle state of the winning definition; null for a fallback, which owns no row.
Show properties
Any of:
string
string
any
any
updatedAtstring<date-time> | anyrequired
When the winning definition last changed; null for a fallback.
Show properties
Any of:
string<date-time>
string<date-time>
any
any
extensionsobject[]required
Extensions referenced by retained report rows, ordered by id.
Show properties
Array of object
idstring<uuid>required
Stable identifier report rows reference.
namestringrequired
Current display name.
numberstring | anyrequired
Dialable number, when the resource has one.
Show properties
Any of:
string
string
any
any
statusstringrequired
Lifecycle state (active, inactive).
updatedAtstring<date-time>required
When the underlying record last changed.
generatedAtstring<date-time>required
When this snapshot was taken. Membership and display values are read in immediate succession rather than from one database instant, so a change landing mid-request may appear in the next refresh instead. Report rows carry each reference name inline, so a row always renders either way.
handlerEntriesobject[]required
Representatives referenced by retained report rows, ordered by id.
Show properties
Array of object
idstring<uuid>required
Stable identifier report rows reference.
namestringrequired
Current display name.
statusstringrequired
Lifecycle state (active, inactive).
updatedAtstring<date-time>required
When the underlying record last changed.
overallSentimentsobject[]required
Overall sentiment definitions referenced by retained report rows, ordered by code.
Show properties
Array of object
codestringrequired
Stable code report rows reference.
labelstringrequired
Current effective label for the code.
scorenumber | anyrequired
Aggregation score, for taxonomies that carry one; null otherwise.
Show properties
Any of:
number
number
any
any
sourcestringrequired
Which definition won: this phone system’s override, the global default, or the deterministic fallback derived from the code itself.
Allowed:phone_system_overrideglobal_defaultfallback
statusstring | anyrequired
Lifecycle state of the winning definition; null for a fallback, which owns no row.
Show properties
Any of:
string
string
any
any
updatedAtstring<date-time> | anyrequired
When the winning definition last changed; null for a fallback.
Show properties
Any of:
string<date-time>
string<date-time>
any
any
400Validation failure: phoneSystemId is not a UUID.
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.
413The snapshot exceeds the transport size limit. params carries actualBytes and maxBytes. This operation returns one complete replace-all snapshot and takes no limit, so the request cannot be narrowed; report rows already carry the IDs, names, and labels they reference.
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.
429The per-key reporting request budget for this operation is exhausted, or the limiter could not be consulted. Retry after the interval in retry_after.
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.
503The membership query exceeded its statement timeout, so no snapshot was built. No partial snapshot is ever returned. Retry the request.
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-log-reports/dimensions" \
  -H "X-API-Key: YOUR_API_KEY"
Response
{
  "callGroups": [
    {
      "id": "<uuid>",
      "name": "string",
      "number": "string",
      "status": "string",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "categories": [
    {
      "code": "string",
      "label": "string",
      "score": 0,
      "source": "phone_system_override",
      "status": "string",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "customerSentiments": [
    {
      "code": "string",
      "label": "string",
      "score": 0,
      "source": "phone_system_override",
      "status": "string",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "employeeSentiments": [
    {
      "code": "string",
      "label": "string",
      "score": 0,
      "source": "phone_system_override",
      "status": "string",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "extensions": [
    {
      "id": "<uuid>",
      "name": "string",
      "number": "string",
      "status": "string",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "generatedAt": "2024-01-01T00:00:00Z",
  "handlerEntries": [
    {
      "id": "<uuid>",
      "name": "string",
      "status": "string",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "overallSentiments": [
    {
      "code": "string",
      "label": "string",
      "score": 0,
      "source": "phone_system_override",
      "status": "string",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ]
}