Get the client tag report
const url = 'https://api.connect.ms/v2/reports/client-tags';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.connect.ms/v2/reports/client-tags \ --header 'Authorization: Bearer <token>'Outbound SMS volume and cost per client tag over a range of dates, with a daily breakdown for each tag.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Only this client tag. Defaults to every tag.
The first day to include (ISO 8601 date, UTC). Defaults to one month before today. No later than today.
The last day to include (ISO 8601 date, UTC). Defaults to today. No later than today.
Header Parameters
Section titled “Header Parameters”The API version to use, for example 2026-10-01. Defaults to the version set on your API key.
Responses
Section titled “Responses”The report.
A report over a range of dates. Reports are not paged.
object
An inclusive range of dates.
object
The first day of the range (ISO 8601 date).
The last day of the range (ISO 8601 date).
The report rows.
Volume and cost for one client tag over the report’s dates.
object
The client tag.
Outbound messages with this tag, whatever their outcome.
SMS parts those messages used.
An amount in each currency it can be priced in, as decimal strings with four decimal places. A currency with no price is null.
object
The amount in pounds sterling, e.g. “0.0350”.
The amount in euros, e.g. “0.0410”.
The same figures broken down by day.
Volume and cost for one client tag on one day.
object
The day (ISO 8601 date).
Outbound messages with this tag that day, whatever their outcome.
SMS parts those messages used.
An amount in each currency it can be priced in, as decimal strings with four decimal places. A currency with no price is null.
object
The amount in pounds sterling, e.g. “0.0350”.
The amount in euros, e.g. “0.0410”.
Example generated
{ "period": { "from": "2026-04-15", "to": "2026-04-15" }, "data": [ { "tag": "example", "sent": 1, "parts": 1, "cost": { "gbp": "example", "eur": "example" }, "daily": [ { "date": "2026-04-15", "sent": 1, "parts": 1, "cost": { "gbp": "example", "eur": "example" } } ] } ]}The request is not valid. The detail field says why, and errors lists any problems by field name.
Why a request failed, in the RFC 9457 problem details format.
object
A URI identifying the kind of problem, ending in a code such as validation_failed, not_found, sending_blocked or rate_limited.
A short, fixed summary of the kind of problem.
The HTTP status code of the response.
What went wrong with this particular request, when there is more to say than the title.
For validation failures, the problems found, keyed by field name (nested fields as template.name, list items as messages[3]).
object
The id recorded for this error, matching the Request-Id header when one is sent. Quote it when contacting support.
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.
Why a request failed, in the RFC 9457 problem details format.
object
A URI identifying the kind of problem, ending in a code such as validation_failed, not_found, sending_blocked or rate_limited.
A short, fixed summary of the kind of problem.
The HTTP status code of the response.
What went wrong with this particular request, when there is more to say than the title.
For validation failures, the problems found, keyed by field name (nested fields as template.name, list items as messages[3]).
object
The id recorded for this error, matching the Request-Id header when one is sent. Quote it when contacting support.
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "errors": { "additionalProperty": [ "example" ] }, "requestId": "example"}The caller is not allowed to do this.
Why a request failed, in the RFC 9457 problem details format.
object
A URI identifying the kind of problem, ending in a code such as validation_failed, not_found, sending_blocked or rate_limited.
A short, fixed summary of the kind of problem.
The HTTP status code of the response.
What went wrong with this particular request, when there is more to say than the title.
For validation failures, the problems found, keyed by field name (nested fields as template.name, list items as messages[3]).
object
The id recorded for this error, matching the Request-Id header when one is sent. Quote it when contacting support.
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.
Why a request failed, in the RFC 9457 problem details format.
object
A URI identifying the kind of problem, ending in a code such as validation_failed, not_found, sending_blocked or rate_limited.
A short, fixed summary of the kind of problem.
The HTTP status code of the response.
What went wrong with this particular request, when there is more to say than the title.
For validation failures, the problems found, keyed by field name (nested fields as template.name, list items as messages[3]).
object
The id recorded for this error, matching the Request-Id header when one is sent. Quote it when contacting support.
Example generated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "errors": { "additionalProperty": [ "example" ] }, "requestId": "example"}