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.

application/json

• Schema
• Example (from schema)

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.

]

]

{
  "data": {
    "detailed": [
      {
        "metrics": [
          {
            "label": "longcode",
            "sent": 1000,
            "delivered": 990,
            "errors": 0.01,
            "received": 750
          }
        ],
        "timestamp": "2019-01-23T18:10:02.574Z"
      }
    ],
    "overview": {
      "record_type": "messaging_profile_metrics",
      "messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "phone_numbers": 250,
      "outbound": {
        "sent": 1000,
        "delivered": 990,
        "errors": 0.01
      },
      "inbound": {
        "received": 850
      }
    }
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

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

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Loading...