List messaging profile metrics

GET 
/messaging_profile_metrics

List messaging profile metrics

Request

Query Parameters

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page

id uuid

The id of the messaging profile(s) to retrieve

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 a list of messaging profile metrics.

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

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.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "data": [
    {
      "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
      }
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

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...