Look Up Message Stats For Your Account

Lets you review your message stats including cost, number of inbound and outbound messages, and the total number of messages sent and received on your account grouped by period in this order: yearly, monthly, daily, and lifetime.

API Upgrade

To upgrade from v2 to v2.1, see Upgrade to Flowroute Messaging API v2.1.

Endpoint

GET /message-stats

Response Format

On success, the HTTP status code in the response header is 200 OK and the response body contains an array of message-stats objects. On error, the header status code is an error code and the response body contains an error object.

data
array
An array of message-stats objects for your account.

attributes
object
Different attributes of a message-stats object:

amount_display float- The cost of the message in USD.
amount_nanodollars number- The cost of the message in nanodollars. The displayed nanodollars amount is the amount_display value multiplied by 1,000,000,000 (one billion) for a corresponding whole number.
date string- Associated period for the returned message stats. This could be a specific year in YYYY format, year and month in YYYY-MM, date in YYYY-MM-DD format, or lifetime.
message_inbound integer- The total number of inbound messages sent to any of your Flowroute long code or toll-free number.
message_outbound integer- The total number of outbound messages sent from any of your Flowroute long code or toll-free number.
message_total string- Combined total number of inbound and outbound messages on your Flowroute account.

id

string

ID of the message-stats object which is equal to the date value.

type

string

This will always be message-stats.

HTTP
cURL

Example Request

GET /v2/message-stats HTTP/1.1
Host: api.flowroute.com
Authorization: Basic ENCODED_CREDENTIALS
User-Agent: curl/7.43.0
Accept: */*
Content-Type: application/json; charset=UTF-8

Example Request

curl -u accessKey:secretKey 
https://api.flowroute.com/v2/message-stats

Example Response

The following example has been clipped for brevity.

200 OK


  "data": [
    {
      "attributes": {
        "amount_display": "$1.4840",
        "amount_nanodollars": 1484000000,
        "date": "2017",
        "message_inbound": 192,
        "message_outbound": 88,
        "message_total": 280
      },
      "id": "2017",
      "type": "message-stats"
    },
    {
      "attributes": {
        "amount_display": "$0.0240",
        "amount_nanodollars": 24000000,
        "date": "2017-01",
        "message_inbound": 0,
        "message_outbound": 6,
        "message_total": 6
      },
      "id": "2017-01",
      "type": "message-stats"
    },
    {
      "attributes": {
        "amount_display": "$0.0240",
        "amount_nanodollars": 24000000,
        "date": "2017-01-31",
        "message_inbound": 0,
        "message_outbound": 6,
        "message_total": 6
      },
      "id": "2017-01-31",
      "type": "message-stats"
    },
      "id": "lifetime",
      "type": "message-stats"
    }
  ]
}

Example Request

Example Request

Example Response

200 OK

sms v2.0

About

Endpoints

Related Articles

Look Up Message Stats For Your Account

API Upgrade

Endpoint

Response Format

data

attributes

id

type