Email message metrics
curl --request POST \
--url https://app.gtm-api.com/email/v4/api/email-messages/metrics \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"period": {
"from": "<string>",
"to": "<string>"
}
}
'import requests
url = "https://app.gtm-api.com/email/v4/api/email-messages/metrics"
payload = { "period": {
"from": "<string>",
"to": "<string>"
} }
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({period: {from: '<string>', to: '<string>'}})
};
fetch('https://app.gtm-api.com/email/v4/api/email-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://app.gtm-api.com/email/v4/api/email-messages/metrics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'period' => [
'from' => '<string>',
'to' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.gtm-api.com/email/v4/api/email-messages/metrics"
payload := strings.NewReader("{\n \"period\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.gtm-api.com/email/v4/api/email-messages/metrics")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"period\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/email/v4/api/email-messages/metrics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"period\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "metrics",
"metrics": {
"period": {
"from": "<string>",
"to": "<string>"
},
"aggregated": {
"counts": {
"total_count": 123,
"groups": {},
"unread_count": 123
},
"metrics": {
"sent_count": 123,
"received_count": 123,
"bounced_count": 123,
"bounce_rate": 123,
"tracked_opens_count": 123,
"open_rate": 123,
"tracked_clicks_count": 123,
"click_rate": 123,
"replied_count": 123,
"reply_rate": 123,
"avg_first_reply_seconds": 123
}
},
"filter": {},
"metrics": {
"sent_count": 123,
"received_count": 123,
"bounced_count": 123,
"bounce_rate": 123,
"tracked_opens_count": 123,
"open_rate": 123,
"tracked_clicks_count": 123,
"click_rate": 123,
"replied_count": 123,
"reply_rate": 123,
"avg_first_reply_seconds": 123
}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"applied_filters": {}
}
email_messages
Email message metrics
The deliverability funnel of a period, by when mail was sent or received: sent_count, received_count, bounced_count and bounce_rate, tracked opens and clicks with their rates over the sends that carried tracking. Reply numbers are not computed here (replied_count 0, the rates null): replies are counted per thread, get_email_threads_metrics. aggregated.counts is every live message, not the period. It covers the whole server: it takes no filter and no split; one mailbox by day is get_email_accounts_daily_sends. period is required. Requires can_view_email_messages.
Contract:
- MCP tool
get_email_messages_metrics, registry packagemcp.email/email_messages, mountemail.messaging. - Operation
metrics, response envelopemetrics. - Flags: read only.
POST
/
api
/
email-messages
/
metrics
Email message metrics
curl --request POST \
--url https://app.gtm-api.com/email/v4/api/email-messages/metrics \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"period": {
"from": "<string>",
"to": "<string>"
}
}
'import requests
url = "https://app.gtm-api.com/email/v4/api/email-messages/metrics"
payload = { "period": {
"from": "<string>",
"to": "<string>"
} }
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({period: {from: '<string>', to: '<string>'}})
};
fetch('https://app.gtm-api.com/email/v4/api/email-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://app.gtm-api.com/email/v4/api/email-messages/metrics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'period' => [
'from' => '<string>',
'to' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.gtm-api.com/email/v4/api/email-messages/metrics"
payload := strings.NewReader("{\n \"period\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.gtm-api.com/email/v4/api/email-messages/metrics")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"period\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/email/v4/api/email-messages/metrics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"period\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "metrics",
"metrics": {
"period": {
"from": "<string>",
"to": "<string>"
},
"aggregated": {
"counts": {
"total_count": 123,
"groups": {},
"unread_count": 123
},
"metrics": {
"sent_count": 123,
"received_count": 123,
"bounced_count": 123,
"bounce_rate": 123,
"tracked_opens_count": 123,
"open_rate": 123,
"tracked_clicks_count": 123,
"click_rate": 123,
"replied_count": 123,
"reply_rate": 123,
"avg_first_reply_seconds": 123
}
},
"filter": {},
"metrics": {
"sent_count": 123,
"received_count": 123,
"bounced_count": 123,
"bounce_rate": 123,
"tracked_opens_count": 123,
"open_rate": 123,
"tracked_clicks_count": 123,
"click_rate": 123,
"replied_count": 123,
"reply_rate": 123,
"avg_first_reply_seconds": 123
}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"applied_filters": {}
}
Authorizations
Headers
Body
application/json