API request metrics
curl --request POST \
--url https://app.gtm-api.com/id/v4/api/api-requests/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>"
]
},
"service": {
"in": [],
"nin": []
},
"surface": {
"in": [],
"nin": []
},
"credential_kind": {
"in": [],
"nin": []
},
"client_sid": {
"eq": "<string>",
"ne": "<string>",
"in": [
"<string>"
],
"nin": [
"<string>"
]
},
"actor_sid": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"entity": {
"eq": "<string>",
"ne": "<string>",
"in": [
"<string>"
],
"nin": [
"<string>"
]
},
"operation": {
"in": [],
"nin": []
},
"action_name": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"route": {
"eq": "<string>",
"ne": "<string>",
"in": [
"<string>"
],
"nin": [
"<string>"
]
},
"status": {
"eq": 123,
"ne": 123,
"in": [
123
],
"nin": [
123
],
"gte": 123,
"lte": 123,
"gt": 123,
"lt": 123
},
"status_family": {
"in": [],
"nin": []
},
"occurred_at": {
"eq": "<string>",
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"trace_id": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
}
}
}
'import requests
url = "https://app.gtm-api.com/id/v4/api/api-requests/metrics"
payload = {
"period": {
"from": "<string>",
"to": "<string>"
},
"filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"service": {
"in": [],
"nin": []
},
"surface": {
"in": [],
"nin": []
},
"credential_kind": {
"in": [],
"nin": []
},
"client_sid": {
"eq": "<string>",
"ne": "<string>",
"in": ["<string>"],
"nin": ["<string>"]
},
"actor_sid": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"entity": {
"eq": "<string>",
"ne": "<string>",
"in": ["<string>"],
"nin": ["<string>"]
},
"operation": {
"in": [],
"nin": []
},
"action_name": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"route": {
"eq": "<string>",
"ne": "<string>",
"in": ["<string>"],
"nin": ["<string>"]
},
"status": {
"eq": 123,
"ne": 123,
"in": [123],
"nin": [123],
"gte": 123,
"lte": 123,
"gt": 123,
"lt": 123
},
"status_family": {
"in": [],
"nin": []
},
"occurred_at": {
"eq": "<string>",
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"trace_id": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
}
}
}
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>']},
service: {in: [], nin: []},
surface: {in: [], nin: []},
credential_kind: {in: [], nin: []},
client_sid: {eq: '<string>', ne: '<string>', in: ['<string>'], nin: ['<string>']},
actor_sid: {eq: '<string>', in: ['<string>'], is_null: true},
entity: {eq: '<string>', ne: '<string>', in: ['<string>'], nin: ['<string>']},
operation: {in: [], nin: []},
action_name: {eq: '<string>', in: ['<string>'], is_null: true},
route: {eq: '<string>', ne: '<string>', in: ['<string>'], nin: ['<string>']},
status: {eq: 123, ne: 123, in: [123], nin: [123], gte: 123, lte: 123, gt: 123, lt: 123},
status_family: {in: [], nin: []},
occurred_at: {
eq: '<string>',
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>'
},
trace_id: {eq: '<string>', in: ['<string>'], is_null: true}
}
})
};
fetch('https://app.gtm-api.com/id/v4/api/api-requests/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/id/v4/api/api-requests/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>'
]
],
'service' => [
'in' => [
],
'nin' => [
]
],
'surface' => [
'in' => [
],
'nin' => [
]
],
'credential_kind' => [
'in' => [
],
'nin' => [
]
],
'client_sid' => [
'eq' => '<string>',
'ne' => '<string>',
'in' => [
'<string>'
],
'nin' => [
'<string>'
]
],
'actor_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'entity' => [
'eq' => '<string>',
'ne' => '<string>',
'in' => [
'<string>'
],
'nin' => [
'<string>'
]
],
'operation' => [
'in' => [
],
'nin' => [
]
],
'action_name' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'route' => [
'eq' => '<string>',
'ne' => '<string>',
'in' => [
'<string>'
],
'nin' => [
'<string>'
]
],
'status' => [
'eq' => 123,
'ne' => 123,
'in' => [
123
],
'nin' => [
123
],
'gte' => 123,
'lte' => 123,
'gt' => 123,
'lt' => 123
],
'status_family' => [
'in' => [
],
'nin' => [
]
],
'occurred_at' => [
'eq' => '<string>',
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
],
'trace_id' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
]
]
]),
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/id/v4/api/api-requests/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 \"service\": {\n \"in\": [],\n \"nin\": []\n },\n \"surface\": {\n \"in\": [],\n \"nin\": []\n },\n \"credential_kind\": {\n \"in\": [],\n \"nin\": []\n },\n \"client_sid\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"actor_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"entity\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"operation\": {\n \"in\": [],\n \"nin\": []\n },\n \"action_name\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"route\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"status\": {\n \"eq\": 123,\n \"ne\": 123,\n \"in\": [\n 123\n ],\n \"nin\": [\n 123\n ],\n \"gte\": 123,\n \"lte\": 123,\n \"gt\": 123,\n \"lt\": 123\n },\n \"status_family\": {\n \"in\": [],\n \"nin\": []\n },\n \"occurred_at\": {\n \"eq\": \"<string>\",\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"trace_id\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\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/id/v4/api/api-requests/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 \"service\": {\n \"in\": [],\n \"nin\": []\n },\n \"surface\": {\n \"in\": [],\n \"nin\": []\n },\n \"credential_kind\": {\n \"in\": [],\n \"nin\": []\n },\n \"client_sid\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"actor_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"entity\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"operation\": {\n \"in\": [],\n \"nin\": []\n },\n \"action_name\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"route\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"status\": {\n \"eq\": 123,\n \"ne\": 123,\n \"in\": [\n 123\n ],\n \"nin\": [\n 123\n ],\n \"gte\": 123,\n \"lte\": 123,\n \"gt\": 123,\n \"lt\": 123\n },\n \"status_family\": {\n \"in\": [],\n \"nin\": []\n },\n \"occurred_at\": {\n \"eq\": \"<string>\",\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"trace_id\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/id/v4/api/api-requests/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 \"service\": {\n \"in\": [],\n \"nin\": []\n },\n \"surface\": {\n \"in\": [],\n \"nin\": []\n },\n \"credential_kind\": {\n \"in\": [],\n \"nin\": []\n },\n \"client_sid\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"actor_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"entity\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"operation\": {\n \"in\": [],\n \"nin\": []\n },\n \"action_name\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"route\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"status\": {\n \"eq\": 123,\n \"ne\": 123,\n \"in\": [\n 123\n ],\n \"nin\": [\n 123\n ],\n \"gte\": 123,\n \"lte\": 123,\n \"gt\": 123,\n \"lt\": 123\n },\n \"status_family\": {\n \"in\": [],\n \"nin\": []\n },\n \"occurred_at\": {\n \"eq\": \"<string>\",\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"trace_id\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "metrics",
"metrics": {
"period": {
"from": "<string>",
"to": "<string>"
},
"aggregated": {
"counts": {},
"metrics": {
"error_rate": 123,
"avg_duration_ms": 123,
"first_occurred_at": "<string>",
"last_occurred_at": "<string>"
}
},
"groups": [
{
"key": "<string>",
"counts": {},
"metrics": {
"error_rate": 123,
"avg_duration_ms": 123,
"first_occurred_at": "<string>",
"last_occurred_at": "<string>"
}
}
],
"series": {
"bucket": "hour",
"points": [
{
"start": "<string>",
"counts": {
"total_count": 123,
"error_count": 123,
"groups": {
"status_family": {}
}
},
"groups": {}
}
]
}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"applied_filters": {}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}api_requests
API request metrics
Period-bound totals of the team’s external API requests, merged across the answering services: total_count, error_count and the 2xx/3xx/4xx/5xx split in aggregated.counts; error_rate, avg_duration_ms, first/last_occurred_at in aggregated.metrics. Requires period (ISO 8601 UTC, half-open, at most 92 days). Optional group_by splits the same numbers per key: client_sid (“how much does each agent call”), route or entity (“which tools”), status_family, service, surface (occurred_hour / occurred_day exist too but bucket is the better time axis). Optional bucket (hour | day) cuts the window into consecutive UTC buckets, series.points[] one per bucket over the whole window with zeros filled, each carrying its own counts and its own group_by split: “requests per day by type” is group_by entity + bucket day in one call. Use to answer “how many calls this week and how many failed” in one round-trip instead of paging the log. aggregated.counts.sources says which services answered.
Contract:
- MCP tool
get_api_request_metrics, registry packagemcp.id/api_requests, mountid.platform. - Operation
metrics, response envelopemetrics. - Flags: read only.
POST
/
api
/
api-requests
/
metrics
API request metrics
curl --request POST \
--url https://app.gtm-api.com/id/v4/api/api-requests/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>"
]
},
"service": {
"in": [],
"nin": []
},
"surface": {
"in": [],
"nin": []
},
"credential_kind": {
"in": [],
"nin": []
},
"client_sid": {
"eq": "<string>",
"ne": "<string>",
"in": [
"<string>"
],
"nin": [
"<string>"
]
},
"actor_sid": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"entity": {
"eq": "<string>",
"ne": "<string>",
"in": [
"<string>"
],
"nin": [
"<string>"
]
},
"operation": {
"in": [],
"nin": []
},
"action_name": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
},
"route": {
"eq": "<string>",
"ne": "<string>",
"in": [
"<string>"
],
"nin": [
"<string>"
]
},
"status": {
"eq": 123,
"ne": 123,
"in": [
123
],
"nin": [
123
],
"gte": 123,
"lte": 123,
"gt": 123,
"lt": 123
},
"status_family": {
"in": [],
"nin": []
},
"occurred_at": {
"eq": "<string>",
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"trace_id": {
"eq": "<string>",
"in": [
"<string>"
],
"is_null": true
}
}
}
'import requests
url = "https://app.gtm-api.com/id/v4/api/api-requests/metrics"
payload = {
"period": {
"from": "<string>",
"to": "<string>"
},
"filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"service": {
"in": [],
"nin": []
},
"surface": {
"in": [],
"nin": []
},
"credential_kind": {
"in": [],
"nin": []
},
"client_sid": {
"eq": "<string>",
"ne": "<string>",
"in": ["<string>"],
"nin": ["<string>"]
},
"actor_sid": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"entity": {
"eq": "<string>",
"ne": "<string>",
"in": ["<string>"],
"nin": ["<string>"]
},
"operation": {
"in": [],
"nin": []
},
"action_name": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
},
"route": {
"eq": "<string>",
"ne": "<string>",
"in": ["<string>"],
"nin": ["<string>"]
},
"status": {
"eq": 123,
"ne": 123,
"in": [123],
"nin": [123],
"gte": 123,
"lte": 123,
"gt": 123,
"lt": 123
},
"status_family": {
"in": [],
"nin": []
},
"occurred_at": {
"eq": "<string>",
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"trace_id": {
"eq": "<string>",
"in": ["<string>"],
"is_null": True
}
}
}
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>']},
service: {in: [], nin: []},
surface: {in: [], nin: []},
credential_kind: {in: [], nin: []},
client_sid: {eq: '<string>', ne: '<string>', in: ['<string>'], nin: ['<string>']},
actor_sid: {eq: '<string>', in: ['<string>'], is_null: true},
entity: {eq: '<string>', ne: '<string>', in: ['<string>'], nin: ['<string>']},
operation: {in: [], nin: []},
action_name: {eq: '<string>', in: ['<string>'], is_null: true},
route: {eq: '<string>', ne: '<string>', in: ['<string>'], nin: ['<string>']},
status: {eq: 123, ne: 123, in: [123], nin: [123], gte: 123, lte: 123, gt: 123, lt: 123},
status_family: {in: [], nin: []},
occurred_at: {
eq: '<string>',
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>'
},
trace_id: {eq: '<string>', in: ['<string>'], is_null: true}
}
})
};
fetch('https://app.gtm-api.com/id/v4/api/api-requests/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/id/v4/api/api-requests/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>'
]
],
'service' => [
'in' => [
],
'nin' => [
]
],
'surface' => [
'in' => [
],
'nin' => [
]
],
'credential_kind' => [
'in' => [
],
'nin' => [
]
],
'client_sid' => [
'eq' => '<string>',
'ne' => '<string>',
'in' => [
'<string>'
],
'nin' => [
'<string>'
]
],
'actor_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'entity' => [
'eq' => '<string>',
'ne' => '<string>',
'in' => [
'<string>'
],
'nin' => [
'<string>'
]
],
'operation' => [
'in' => [
],
'nin' => [
]
],
'action_name' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
],
'route' => [
'eq' => '<string>',
'ne' => '<string>',
'in' => [
'<string>'
],
'nin' => [
'<string>'
]
],
'status' => [
'eq' => 123,
'ne' => 123,
'in' => [
123
],
'nin' => [
123
],
'gte' => 123,
'lte' => 123,
'gt' => 123,
'lt' => 123
],
'status_family' => [
'in' => [
],
'nin' => [
]
],
'occurred_at' => [
'eq' => '<string>',
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
],
'trace_id' => [
'eq' => '<string>',
'in' => [
'<string>'
],
'is_null' => true
]
]
]),
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/id/v4/api/api-requests/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 \"service\": {\n \"in\": [],\n \"nin\": []\n },\n \"surface\": {\n \"in\": [],\n \"nin\": []\n },\n \"credential_kind\": {\n \"in\": [],\n \"nin\": []\n },\n \"client_sid\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"actor_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"entity\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"operation\": {\n \"in\": [],\n \"nin\": []\n },\n \"action_name\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"route\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"status\": {\n \"eq\": 123,\n \"ne\": 123,\n \"in\": [\n 123\n ],\n \"nin\": [\n 123\n ],\n \"gte\": 123,\n \"lte\": 123,\n \"gt\": 123,\n \"lt\": 123\n },\n \"status_family\": {\n \"in\": [],\n \"nin\": []\n },\n \"occurred_at\": {\n \"eq\": \"<string>\",\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"trace_id\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\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/id/v4/api/api-requests/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 \"service\": {\n \"in\": [],\n \"nin\": []\n },\n \"surface\": {\n \"in\": [],\n \"nin\": []\n },\n \"credential_kind\": {\n \"in\": [],\n \"nin\": []\n },\n \"client_sid\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"actor_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"entity\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"operation\": {\n \"in\": [],\n \"nin\": []\n },\n \"action_name\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"route\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"status\": {\n \"eq\": 123,\n \"ne\": 123,\n \"in\": [\n 123\n ],\n \"nin\": [\n 123\n ],\n \"gte\": 123,\n \"lte\": 123,\n \"gt\": 123,\n \"lt\": 123\n },\n \"status_family\": {\n \"in\": [],\n \"nin\": []\n },\n \"occurred_at\": {\n \"eq\": \"<string>\",\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"trace_id\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/id/v4/api/api-requests/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 \"service\": {\n \"in\": [],\n \"nin\": []\n },\n \"surface\": {\n \"in\": [],\n \"nin\": []\n },\n \"credential_kind\": {\n \"in\": [],\n \"nin\": []\n },\n \"client_sid\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"actor_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"entity\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"operation\": {\n \"in\": [],\n \"nin\": []\n },\n \"action_name\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n },\n \"route\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"status\": {\n \"eq\": 123,\n \"ne\": 123,\n \"in\": [\n 123\n ],\n \"nin\": [\n 123\n ],\n \"gte\": 123,\n \"lte\": 123,\n \"gt\": 123,\n \"lt\": 123\n },\n \"status_family\": {\n \"in\": [],\n \"nin\": []\n },\n \"occurred_at\": {\n \"eq\": \"<string>\",\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"trace_id\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"is_null\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "metrics",
"metrics": {
"period": {
"from": "<string>",
"to": "<string>"
},
"aggregated": {
"counts": {},
"metrics": {
"error_rate": 123,
"avg_duration_ms": 123,
"first_occurred_at": "<string>",
"last_occurred_at": "<string>"
}
},
"groups": [
{
"key": "<string>",
"counts": {},
"metrics": {
"error_rate": 123,
"avg_duration_ms": 123,
"first_occurred_at": "<string>",
"last_occurred_at": "<string>"
}
}
],
"series": {
"bucket": "hour",
"points": [
{
"start": "<string>",
"counts": {
"total_count": 123,
"error_count": 123,
"groups": {
"status_family": {}
}
},
"groups": {}
}
]
}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"applied_filters": {}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}Authorizations
Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.
Team scope for tokens that do not carry one. Ignored when the token already names a team.
Body
application/json
Request body of get_api_request_metrics.
Required metrics window [from, to). Operators on occurred_at inside filter are ignored.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Split the aggregate per key: client_sid / route / entity / status_family / service / surface = breakdowns (occurred_hour / occurred_day = a legacy time split; prefer bucket). Cap 500 groups.
Available options:
service, surface, credential_kind, client_sid, entity, operation, route, status_family, occurred_day, occurred_hour The time axis, independent of group_by: hour or day (UTC). Answers series.points[], one per bucket over the whole window, zeros filled, each with its own counts and group_by split.
Available options:
hour, day