Retrieve Volume Metrics

GET 
https://api.mailchannels.net/tx/v1/metrics/volume

Retrieve volume metrics for messages sent from your account, including counts of processed, delivered and dropped events. Supports optional filters for time range and campaign ID.

Request

Query Parameters

start_time string
The beginning of the time range for retrieving message volume metrics (inclusive). Formats: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ. Defaults to one month ago if not provided.
Example: 2025-05-26
end_time string
The end of the time range for retrieving message volume metrics (exclusive). Formats: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ. Defaults to the current time if not provided.
Example: 2025-05-31T15:16:17Z
campaign_id string

Header Parameters

X-Api-Key stringrequired

Responses

200

Successfully retrieved volume metrics

application/json

Schema

Schema

deliveredintegerrequired

Count of messages delivered during the specified time range.

Possible values: >= 0

droppedintegerrequired

Count of messages dropped during the specified time range.

Possible values: >= 0

end_timedate-time

The end of the time range for retrieving message volume metrics (exclusive).

processedintegerrequired

Count of messages processed during the specified time range.

Possible values: >= 0

start_timedate-time

The beginning of the time range for retrieving message volume metrics (inclusive).

Example (auto)

{
  "delivered": 0,
  "dropped": 0,
  "end_time": "2024-07-29T15:51:28.071Z",
  "processed": 0,
  "start_time": "2024-07-29T15:51:28.071Z"
}

400

Bad Request

application/json

Schema

Schema

errorsstring[]

This is an array error objects that provide machine and human readable descriptions of the errors.

Example (auto)

{
  "errors": [
    "string"
  ]
}

500

Internal Server Error

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.mailchannels.net/tx/v1/metrics/volume");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.mailchannels.net/tx/v1

Parameters

X-Api-Key — headerrequired

start_time — query

end_time — query

campaign_id — query

ResponseClear

Click the Send API Request button above and see the response here!