Skip to main content

Retrieve messaging profile metrics

GET 

/messaging_profiles/:id/metrics

Retrieve messaging profile metrics

Request

Path Parameters

    id uuidrequired

    The id of the messaging profile to retrieve

Query Parameters

    time_frame string

    Possible values: [1h, 3h, 24h, 3d, 7d, 30d]

    Default value: 24h

    The timeframe for which you'd like to retrieve metrics.

Responses

200: Successful response with details about a messaging profile's metrics.

Schema

    data

    object

    overview

    object

    record_type string

    Possible values: [messaging_profile_metrics]

    Identifies the type of the resource.

    messaging_profile_id uuid

    Identifies the type of resource.

    phone_numbers number

    The number of phone numbers associated with the messaging profile.

    outbound

    object

    sent number

    The number of outbound messages sent.

    delivered number

    The number of outbound messages successfully delivered.

    error_ratio number

    The ratio of messages sent that resulted in errors.

    inbound

    object

    received number

    The number of inbound messages received.

    detailed

    object[]

  • Array [

  • timestamp string

    The timestamp of the aggregated data.

    metrics

    object[]

  • Array [

  • label string

    The metric type.

    sent number

    The number of outbound messages sent.

    delivered number

    The number of outbound messages successfully delivered.

    outbound_error_ratio number

    The ratio of outbound messages sent that resulted in errors.

    received number

    The number of inbound messages received.

  • ]

  • ]

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

  • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
  • ]

Loading...