Messages

Get message metrics

Returns your texting over a window (the last 7 days by default, starting at most a year back): texts sent and received, how the sent ones ended up (delivered, left the phone with no delivery report, unconfirmed, failed, still queued) and the delivery rate, how long they took to send and to be delivered, why they failed, your conversations and how many of the ones you texted wrote back within a day, and each phone’s share with its busiest 30 minutes, to compare with the send_limit the response carries. The points chart it by the hour or the day (granularity) in time_zone; hour buckets need a window of 7 days or less. Scope it to one phone with phone_id or one conversation with conversation_id. A text counts at the time the platform stored it when sent, and when the phone received it when received.

GET

messages

metrics

Get message metrics

curl --request GET \
  --url https://api.axilio.ai/api/v1/messages/metrics \
  --header 'X-Axilio-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Axilio-Api-Key': '<api-key>'}};

fetch('https://api.axilio.ai/api/v1/messages/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.axilio.ai/api/v1/messages/metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Axilio-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.axilio.ai/api/v1/messages/metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/messages/metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "conversations": {
    "active": 123,
    "by_outcome": {
      "delivered": 123,
      "failed": 123,
      "no_report": 123,
      "queued": 123,
      "unconfirmed": 123
    },
    "replied": 123,
    "reply_latency_ms": {
      "p50": 123,
      "p95": 123
    },
    "reply_rate": 0.5,
    "response_latency_ms": {
      "p50": 123,
      "p95": 123
    },
    "started": 123,
    "texted": 123
  },
  "delivery_latency_ms": {
    "p50": 123,
    "p95": 123
  },
  "delivery_rate": 0.5,
  "failures": [
    {
      "conversations": 123,
      "count": 123,
      "error_code": "phone_unreachable",
      "numbers": 123,
      "phones": [
        {
          "count": 123,
          "phone_id": "<string>"
        }
      ]
    }
  ],
  "period_end_at": "2023-11-07T05:31:56Z",
  "period_start_at": "2023-11-07T05:31:56Z",
  "phones": [
    {
      "conversations": 123,
      "delivered": 123,
      "delivery_rate": 0.5,
      "failed": 123,
      "no_report": 123,
      "peak_at": "2023-11-07T05:31:56Z",
      "peak_sent_30m": 123,
      "phone_id": "<string>",
      "queued": 123,
      "received": 123,
      "sent": 123,
      "unconfirmed": 123
    }
  ],
  "points": [
    {
      "delivered": 123,
      "failed": 123,
      "no_report": 123,
      "period_start_at": "2023-11-07T05:31:56Z",
      "queued": 123,
      "received": 123,
      "send_p50_ms": 123,
      "send_p95_ms": 123,
      "sent": 123,
      "unconfirmed": 123
    }
  ],
  "send_latency_ms": {
    "p50": 123,
    "p95": 123
  },
  "send_limit": {
    "count": 123,
    "window_seconds": 123
  },
  "totals": {
    "delivered": 123,
    "failed": 123,
    "no_report": 123,
    "numbers_received_from": 123,
    "numbers_texted": 123,
    "phones_sending": 123,
    "queued": 123,
    "received": 123,
    "sent": 123,
    "unconfirmed": 123
  }
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Minimum role required: Viewer

Authorizations

X-Axilio-Api-Key

string

header

required

Customer API key (axl_ prefix).

Query Parameters

period_start_at

string<date-time>

Start of the window (RFC 3339). Defaults to 7 days before period_end_at, and may be at most a year before now.

period_end_at

string<date-time>

End of the window (RFC 3339). Defaults to now, and a later time is read as now.

granularity

enum<string>

default:day

Bucket size: hour or day. hour is allowed for windows of 7 days or less.

Available options:

hour,

day

time_zone

string

default:UTC

IANA time zone the buckets follow, such as America/Los_Angeles: a day starts at local midnight and an hour on the local hour. An unknown name is an error.

phone_id

string

Only this phone's texts. A phone your organization doesn't rent is not found.

Maximum string length: 64

conversation_id

string<uuid>

Only this conversation's texts, and only its phone. Another organization's conversation is not found. When phone_id is also given, it is ignored: the conversation names the phone.

Response

Your texting over a window: volume, how the texts ended up, how long they took, why they failed, your conversations, and each phone's share.

conversations

object

required

The window's conversations.

Show child attributes

delivery_latency_ms

object

required

From a text being sent to its delivery report, over texts that have one. Null when none does.

Show child attributes

delivery_rate

number<double> | null

required

Delivered over sent, not counting texts still queued, from 0 to 1. Null when nothing settled.

Required range: 0 <= x <= 1

failures

object[] | null

required

Why texts failed, most failures first.

Show child attributes

period_end_at

string<date-time>

required

End of the window, as resolved: never later than now.

period_start_at

string<date-time>

required

Start of the window, as resolved.

phones

object[] | null

required

One entry per phone in scope, most texts sent first: every phone your organization rents, even one with no texts, or the one phone or conversation asked for.

Show child attributes

points

object[] | null

required

One point per bucket (granularity, in time_zone), oldest first, every measure present. The first bucket starts at or before the window's start.

Show child attributes

send_latency_ms

object

required

From the platform storing a text to the phone sending it, over texts that were sent. Null when none was.

Show child attributes

send_limit

object

required

The send limit each phone is held to: compare it with a phone's peak_sent_30m for its headroom.

Show child attributes

totals

object

required

The window's texts in all.

Show child attributes

Get message metrics

curl --request GET \
  --url https://api.axilio.ai/api/v1/messages/metrics \
  --header 'X-Axilio-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Axilio-Api-Key': '<api-key>'}};

fetch('https://api.axilio.ai/api/v1/messages/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.axilio.ai/api/v1/messages/metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Axilio-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.axilio.ai/api/v1/messages/metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/messages/metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "conversations": {
    "active": 123,
    "by_outcome": {
      "delivered": 123,
      "failed": 123,
      "no_report": 123,
      "queued": 123,
      "unconfirmed": 123
    },
    "replied": 123,
    "reply_latency_ms": {
      "p50": 123,
      "p95": 123
    },
    "reply_rate": 0.5,
    "response_latency_ms": {
      "p50": 123,
      "p95": 123
    },
    "started": 123,
    "texted": 123
  },
  "delivery_latency_ms": {
    "p50": 123,
    "p95": 123
  },
  "delivery_rate": 0.5,
  "failures": [
    {
      "conversations": 123,
      "count": 123,
      "error_code": "phone_unreachable",
      "numbers": 123,
      "phones": [
        {
          "count": 123,
          "phone_id": "<string>"
        }
      ]
    }
  ],
  "period_end_at": "2023-11-07T05:31:56Z",
  "period_start_at": "2023-11-07T05:31:56Z",
  "phones": [
    {
      "conversations": 123,
      "delivered": 123,
      "delivery_rate": 0.5,
      "failed": 123,
      "no_report": 123,
      "peak_at": "2023-11-07T05:31:56Z",
      "peak_sent_30m": 123,
      "phone_id": "<string>",
      "queued": 123,
      "received": 123,
      "sent": 123,
      "unconfirmed": 123
    }
  ],
  "points": [
    {
      "delivered": 123,
      "failed": 123,
      "no_report": 123,
      "period_start_at": "2023-11-07T05:31:56Z",
      "queued": 123,
      "received": 123,
      "send_p50_ms": 123,
      "send_p95_ms": 123,
      "sent": 123,
      "unconfirmed": 123
    }
  ],
  "send_latency_ms": {
    "p50": 123,
    "p95": 123
  },
  "send_limit": {
    "count": 123,
    "window_seconds": 123
  },
  "totals": {
    "delivered": 123,
    "failed": 123,
    "no_report": 123,
    "numbers_received_from": 123,
    "numbers_texted": 123,
    "phones_sending": 123,
    "queued": 123,
    "received": 123,
    "sent": 123,
    "unconfirmed": 123
  }
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Overview

Device Control Protocol

REST API

Argus API

Get message metrics

Authorizations

Query Parameters

Response