Skip to content

Get the latency report

GET
/v2/reports/latency
curl --request GET \
--url https://api.connect.ms/v2/reports/latency \
--header 'Authorization: Bearer <token>'

How long the networks took to process your outbound SMS messages over a range of dates, as counts per time bucket.

since
string format: date
nullable

The first day to include (ISO 8601 date, UTC). Defaults to one month before today.

until
string format: date
nullable

The last day to include (ISO 8601 date, UTC). Defaults to today.

Connect-Version
string

The API version to use, for example 2026-10-01. Defaults to the version set on your API key.

The report.

Media typeapplication/json

Network latency for outbound messages over a range of dates.

object
period
required
One of:

An inclusive range of dates.

object
from
required

The first day of the range (ISO 8601 date).

string format: date
to
required

The last day of the range (ISO 8601 date).

string format: date
latency
required
One of:

How long the networks took to process outbound messages, as a count per time bucket.

object
total
required

All outbound messages in the range.

integer format: int32
measured
required

Messages whose latency could be measured. The buckets add up to this.

integer format: int32
buckets
required

The fixed buckets in ascending order, from under one second to over five minutes. Always all eight, even when empty.

Array<object>

A latency bucket.

object
label
required

The time range of the bucket, e.g. “<1s”, “1-2s” or “5m+”.

string
count
required

Messages whose latency fell in this bucket.

integer format: int32

Example generated

{
"period": {
"from": "2026-04-15",
"to": "2026-04-15"
},
"latency": {
"total": 1,
"measured": 1,
"buckets": [
{
"label": "example",
"count": 1
}
]
}
}

The request is not valid. The detail field says why, and errors lists any problems by field name.

Media typeapplication/problem+json

Why a request failed, in the RFC 9457 problem details format.

object
type
required

A URI identifying the kind of problem, ending in a code such as validation_failed, not_found, sending_blocked or rate_limited.

string
title
required

A short, fixed summary of the kind of problem.

string
status
required

The HTTP status code of the response.

integer format: int32
detail

What went wrong with this particular request, when there is more to say than the title.

string
nullable
errors

For validation failures, the problems found, keyed by field name (nested fields as template.name, list items as messages[3]).

object
key
additional properties
Array<string>
requestId
required

The id recorded for this error, matching the Request-Id header when one is sent. Quote it when contacting support.

string

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
},
"requestId": "example"
}

The API key or bearer token is missing or not valid, or the request signature could not be verified.

Media typeapplication/problem+json

Why a request failed, in the RFC 9457 problem details format.

object
type
required

A URI identifying the kind of problem, ending in a code such as validation_failed, not_found, sending_blocked or rate_limited.

string
title
required

A short, fixed summary of the kind of problem.

string
status
required

The HTTP status code of the response.

integer format: int32
detail

What went wrong with this particular request, when there is more to say than the title.

string
nullable
errors

For validation failures, the problems found, keyed by field name (nested fields as template.name, list items as messages[3]).

object
key
additional properties
Array<string>
requestId
required

The id recorded for this error, matching the Request-Id header when one is sent. Quote it when contacting support.

string

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
},
"requestId": "example"
}

The caller is not allowed to do this.

Media typeapplication/problem+json

Why a request failed, in the RFC 9457 problem details format.

object
type
required

A URI identifying the kind of problem, ending in a code such as validation_failed, not_found, sending_blocked or rate_limited.

string
title
required

A short, fixed summary of the kind of problem.

string
status
required

The HTTP status code of the response.

integer format: int32
detail

What went wrong with this particular request, when there is more to say than the title.

string
nullable
errors

For validation failures, the problems found, keyed by field name (nested fields as template.name, list items as messages[3]).

object
key
additional properties
Array<string>
requestId
required

The id recorded for this error, matching the Request-Id header when one is sent. Quote it when contacting support.

string

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
},
"requestId": "example"
}

The service is temporarily unavailable. Retry after the Retry-After header.

Media typeapplication/problem+json

Why a request failed, in the RFC 9457 problem details format.

object
type
required

A URI identifying the kind of problem, ending in a code such as validation_failed, not_found, sending_blocked or rate_limited.

string
title
required

A short, fixed summary of the kind of problem.

string
status
required

The HTTP status code of the response.

integer format: int32
detail

What went wrong with this particular request, when there is more to say than the title.

string
nullable
errors

For validation failures, the problems found, keyed by field name (nested fields as template.name, list items as messages[3]).

object
key
additional properties
Array<string>
requestId
required

The id recorded for this error, matching the Request-Id header when one is sent. Quote it when contacting support.

string

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
},
"requestId": "example"
}