Email engagement metrics
curl --request POST \
--url https://app.gtm-api.com/email/v4/api/email-engagements/metrics \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"period": {
"from": "<string>",
"to": "<string>"
},
"filter": {
"sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"email_message_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"email_account_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"kind": {
"in": [],
"nin": []
},
"is_bot_filtered": {
"eq": true,
"in": [
true
]
},
"occurred_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
}
}
}
'import requests
url = "https://app.gtm-api.com/email/v4/api/email-engagements/metrics"
payload = {
"period": {
"from": "<string>",
"to": "<string>"
},
"filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"email_message_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"email_account_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"kind": {
"in": [],
"nin": []
},
"is_bot_filtered": {
"eq": True,
"in": [True]
},
"occurred_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<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>'},
filter: {
sid: {eq: '<string>', in: ['<string>']},
email_message_sid: {eq: '<string>', in: ['<string>']},
email_account_sid: {eq: '<string>', in: ['<string>']},
kind: {in: [], nin: []},
is_bot_filtered: {eq: true, in: [true]},
occurred_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'}
}
})
};
fetch('https://app.gtm-api.com/email/v4/api/email-engagements/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-engagements/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>'
],
'filter' => [
'sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'email_message_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'email_account_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'kind' => [
'in' => [
],
'nin' => [
]
],
'is_bot_filtered' => [
'eq' => true,
'in' => [
true
]
],
'occurred_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<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-engagements/metrics"
payload := strings.NewReader("{\n \"period\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"email_message_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"email_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"kind\": {\n \"in\": [],\n \"nin\": []\n },\n \"is_bot_filtered\": {\n \"eq\": true,\n \"in\": [\n true\n ]\n },\n \"occurred_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\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-engagements/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 \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"email_message_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"email_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"kind\": {\n \"in\": [],\n \"nin\": []\n },\n \"is_bot_filtered\": {\n \"eq\": true,\n \"in\": [\n true\n ]\n },\n \"occurred_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/email/v4/api/email-engagements/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 \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"email_message_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"email_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"kind\": {\n \"in\": [],\n \"nin\": []\n },\n \"is_bot_filtered\": {\n \"eq\": true,\n \"in\": [\n true\n ]\n },\n \"occurred_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\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": {}
},
"metrics": {
"hits_count": 123,
"unique_messages_count": 123
}
},
"filter": {},
"metrics": {
"hits_count": 123,
"unique_messages_count": 123
},
"groups": [
{
"key": "<string>",
"metrics": {
"hits_count": 123,
"unique_messages_count": 123
}
}
]
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"applied_filters": {}
}email_engagements
Email engagement metrics
Tracking hits over a period: hits_count and unique_messages_count (the messages that were opened, clicked or unsubscribed from). group_by kind splits them per kind; group_by is_bot_filtered, with filter.is_bot_filtered lifted to { in: [true, false] }, shows how much of the volume is scanners. Scanner hits are left out by default. period is required and at most 92 days (422 period_too_wide past that). Requires can_view_email_engagements.
Contract:
- MCP tool `get_email_engagements_metrics`, registry package `mcp.email/email_engagements`, mount `email.deliverability`.
- Operation `metrics`, response envelope `metrics`.
- Flags: read only.
POST
/
api
/
email-engagements
/
metrics
Email engagement metrics
curl --request POST \
--url https://app.gtm-api.com/email/v4/api/email-engagements/metrics \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"period": {
"from": "<string>",
"to": "<string>"
},
"filter": {
"sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"email_message_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"email_account_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"kind": {
"in": [],
"nin": []
},
"is_bot_filtered": {
"eq": true,
"in": [
true
]
},
"occurred_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
}
}
}
'import requests
url = "https://app.gtm-api.com/email/v4/api/email-engagements/metrics"
payload = {
"period": {
"from": "<string>",
"to": "<string>"
},
"filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"email_message_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"email_account_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"kind": {
"in": [],
"nin": []
},
"is_bot_filtered": {
"eq": True,
"in": [True]
},
"occurred_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<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>'},
filter: {
sid: {eq: '<string>', in: ['<string>']},
email_message_sid: {eq: '<string>', in: ['<string>']},
email_account_sid: {eq: '<string>', in: ['<string>']},
kind: {in: [], nin: []},
is_bot_filtered: {eq: true, in: [true]},
occurred_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'}
}
})
};
fetch('https://app.gtm-api.com/email/v4/api/email-engagements/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-engagements/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>'
],
'filter' => [
'sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'email_message_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'email_account_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'kind' => [
'in' => [
],
'nin' => [
]
],
'is_bot_filtered' => [
'eq' => true,
'in' => [
true
]
],
'occurred_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<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-engagements/metrics"
payload := strings.NewReader("{\n \"period\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"email_message_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"email_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"kind\": {\n \"in\": [],\n \"nin\": []\n },\n \"is_bot_filtered\": {\n \"eq\": true,\n \"in\": [\n true\n ]\n },\n \"occurred_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\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-engagements/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 \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"email_message_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"email_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"kind\": {\n \"in\": [],\n \"nin\": []\n },\n \"is_bot_filtered\": {\n \"eq\": true,\n \"in\": [\n true\n ]\n },\n \"occurred_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/email/v4/api/email-engagements/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 \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"email_message_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"email_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"kind\": {\n \"in\": [],\n \"nin\": []\n },\n \"is_bot_filtered\": {\n \"eq\": true,\n \"in\": [\n true\n ]\n },\n \"occurred_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\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": {}
},
"metrics": {
"hits_count": 123,
"unique_messages_count": 123
}
},
"filter": {},
"metrics": {
"hits_count": 123,
"unique_messages_count": 123
},
"groups": [
{
"key": "<string>",
"metrics": {
"hits_count": 123,
"unique_messages_count": 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