Get call quality metrics

Returns a paginated list of historical call quality metrics, including jitter, round-trip time (RTT), MOS scores, and packet loss percentages per call.
The filter and order_by parameters use an OData-like syntax.
Calls without metrics have jitter, mos and rtt set to null; add a filter such as mos/avg gt 0 to exclude them.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

guardian-call-quality:read

Query Params
string
length ≤ 1600

Allows filtering by using an OData-like syntax with comparison and logical operators.


Filterable fields: call_id, interaction_id, user_id, timestamp, affected_call, packets_loss_percentage,
mos/avg, mos/min, mos/max, jitter/avg, jitter/max, rtt/avg, rtt/min, rtt/max.

Nested fields are referenced with a forward slash, e.g. mos/avg. The dot (mos.avg) and underscore (mos_avg) notations are not supported.

String and timestamp values must be wrapped in single quotes; timestamps use ISO 8601 format (e.g. '2020-12-18T13:09:09.417Z'). Numbers and booleans are not quoted.

  • To search parts of a string within a field of type string then the contains operator should be used.
    The syntax is the following: contains(field, 'value')

  • Logical operators are and and or.

    When using multiple ANDs and ORs, you should use parentheses to explicitly define the logical operators evaluation order.

    (note: this is recommended because the usual precedence rules aren't supported due to an implementation detail).


    Examples:

    • mos/avg gt 0 and mos/avg lt 3
    • affected_call eq true and packets_loss_percentage gt 5
    • (contains(user_id, 'agent1') or contains(user_id, 'agent2')) and timestamp ge '2020-12-18T00:00:00.000Z'
    string
    length ≤ 300
    Defaults to call_id:asc

    Sorts by the indicated field in the specified direction, ascending or descending.

    The expression format may contain the suffix asc or desc separated from the property name with a colon in between.

    Nested fields are referenced with a forward slash, e.g. mos/avg:asc. The dot (mos.avg) and underscore (mos_avg) notations are not supported.

    Records with null values come first in ascending order; combine with a filter such as mos/avg gt 0 to exclude calls without metrics.

    Examples:

    • timestamp:desc
    • mos/avg:asc
    • packets_loss_percentage:desc
    int32
    1 to 2147483647
    Defaults to 1

    Number of the requested page

    int32
    1 to 250
    Defaults to 10

    Max number of the items in a page

    Headers
    string
    enum
    Defaults to application/json

    Generated from available response content types

    Allowed:
    Responses

    Language
    Credentials
    OAuth2
    Missing 1 required scope
    URL
    LoadingLoading…
    Response
    Choose an example:
    application/json
    text/csv