Mass-action metrics
curl --request POST \
--url https://app.gtm-api.com/orchestration/v4/api/mass-actions/metrics \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"filter": {
"sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"team_sid": {
"eq": "<string>"
},
"target_entity": {
"eq": "<string>",
"ne": "<string>",
"in": [
"<string>"
],
"nin": [
"<string>"
]
},
"status": {
"in": []
},
"paused_reason": {
"in": [],
"is_null": true
},
"hold_till": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": true
},
"canary_satisfied_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
},
"started_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": true
},
"settled_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": true
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"updated_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"deleted_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
}
}
}
'import requests
url = "https://app.gtm-api.com/orchestration/v4/api/mass-actions/metrics"
payload = { "filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"team_sid": { "eq": "<string>" },
"target_entity": {
"eq": "<string>",
"ne": "<string>",
"in": ["<string>"],
"nin": ["<string>"]
},
"status": { "in": [] },
"paused_reason": {
"in": [],
"is_null": True
},
"hold_till": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": True
},
"canary_satisfied_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": True
},
"started_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": True
},
"settled_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": True
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"updated_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"deleted_at": {
"gte": "<string>",
"lte": "<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({
filter: {
sid: {eq: '<string>', in: ['<string>']},
team_sid: {eq: '<string>'},
target_entity: {eq: '<string>', ne: '<string>', in: ['<string>'], nin: ['<string>']},
status: {in: []},
paused_reason: {in: [], is_null: true},
hold_till: {
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>',
is_null: true
},
canary_satisfied_at: {gte: '<string>', lte: '<string>', is_null: true},
started_at: {
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>',
is_null: true
},
settled_at: {
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>',
is_null: true
},
created_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'},
updated_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'},
deleted_at: {gte: '<string>', lte: '<string>', is_null: true}
}
})
};
fetch('https://app.gtm-api.com/orchestration/v4/api/mass-actions/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/orchestration/v4/api/mass-actions/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([
'filter' => [
'sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'team_sid' => [
'eq' => '<string>'
],
'target_entity' => [
'eq' => '<string>',
'ne' => '<string>',
'in' => [
'<string>'
],
'nin' => [
'<string>'
]
],
'status' => [
'in' => [
]
],
'paused_reason' => [
'in' => [
],
'is_null' => true
],
'hold_till' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>',
'is_null' => true
],
'canary_satisfied_at' => [
'gte' => '<string>',
'lte' => '<string>',
'is_null' => true
],
'started_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>',
'is_null' => true
],
'settled_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>',
'is_null' => true
],
'created_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
],
'updated_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
],
'deleted_at' => [
'gte' => '<string>',
'lte' => '<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/orchestration/v4/api/mass-actions/metrics"
payload := strings.NewReader("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"team_sid\": {\n \"eq\": \"<string>\"\n },\n \"target_entity\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"status\": {\n \"in\": []\n },\n \"paused_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"hold_till\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"canary_satisfied_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"started_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"settled_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"updated_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\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/orchestration/v4/api/mass-actions/metrics")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"team_sid\": {\n \"eq\": \"<string>\"\n },\n \"target_entity\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"status\": {\n \"in\": []\n },\n \"paused_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"hold_till\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"canary_satisfied_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"started_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"settled_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"updated_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/orchestration/v4/api/mass-actions/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 \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"team_sid\": {\n \"eq\": \"<string>\"\n },\n \"target_entity\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"status\": {\n \"in\": []\n },\n \"paused_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"hold_till\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"canary_satisfied_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"started_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"settled_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"updated_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "metrics",
"metrics": {
"filter": {},
"period": {
"from": "<string>",
"to": "<string>"
},
"aggregated": {
"counts": {},
"metrics": {
"items_by_status": {},
"items_by_current_step": {},
"items_by_wait_reason": {},
"in_flight": 123,
"next_scheduled_at": "<string>",
"last_scheduled_at": "<string>",
"credits_spent": 123,
"created_objects": {},
"top_errors": [
{
"prefix": "<string>",
"count": 123
}
]
}
},
"metrics": {
"items_by_status": {},
"items_by_current_step": {},
"items_by_wait_reason": {},
"in_flight": 123,
"next_scheduled_at": "<string>",
"last_scheduled_at": "<string>",
"credits_spent": 123,
"created_objects": {},
"top_errors": [
{
"prefix": "<string>",
"count": 123
}
]
}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
},
"applied_filters": {}
}{
"success": false,
"error": {
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"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,
"debug_url": "<string>"
}
}{
"success": false,
"error": {
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"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,
"debug_url": "<string>"
}
}mass_actions
Mass-action metrics
Where a run is right now, in one round-trip, without paging items. Typical call: filter {sid:{eq}}. Returns items_by_status (the outcome split), items_by_current_step, items_by_wait_reason, in_flight (0 means the run is caught up), the next / last scheduled item, credits_spent, created_objects and the top error prefixes. No group_by: the shape is fixed. Use this instead of listing a run's items to answer 'how is it going'.
Contract:
- MCP tool `get_mass_actions_metrics`, registry package `mcp.orchestration/mass_actions`, mount `orchestration.mass_actions`.
- Operation `metrics`, response envelope `metrics`.
- Flags: read only.
POST
/
api
/
mass-actions
/
metrics
Mass-action metrics
curl --request POST \
--url https://app.gtm-api.com/orchestration/v4/api/mass-actions/metrics \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"filter": {
"sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"team_sid": {
"eq": "<string>"
},
"target_entity": {
"eq": "<string>",
"ne": "<string>",
"in": [
"<string>"
],
"nin": [
"<string>"
]
},
"status": {
"in": []
},
"paused_reason": {
"in": [],
"is_null": true
},
"hold_till": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": true
},
"canary_satisfied_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
},
"started_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": true
},
"settled_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": true
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"updated_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"deleted_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
}
}
}
'import requests
url = "https://app.gtm-api.com/orchestration/v4/api/mass-actions/metrics"
payload = { "filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"team_sid": { "eq": "<string>" },
"target_entity": {
"eq": "<string>",
"ne": "<string>",
"in": ["<string>"],
"nin": ["<string>"]
},
"status": { "in": [] },
"paused_reason": {
"in": [],
"is_null": True
},
"hold_till": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": True
},
"canary_satisfied_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": True
},
"started_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": True
},
"settled_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": True
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"updated_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"deleted_at": {
"gte": "<string>",
"lte": "<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({
filter: {
sid: {eq: '<string>', in: ['<string>']},
team_sid: {eq: '<string>'},
target_entity: {eq: '<string>', ne: '<string>', in: ['<string>'], nin: ['<string>']},
status: {in: []},
paused_reason: {in: [], is_null: true},
hold_till: {
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>',
is_null: true
},
canary_satisfied_at: {gte: '<string>', lte: '<string>', is_null: true},
started_at: {
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>',
is_null: true
},
settled_at: {
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>',
is_null: true
},
created_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'},
updated_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'},
deleted_at: {gte: '<string>', lte: '<string>', is_null: true}
}
})
};
fetch('https://app.gtm-api.com/orchestration/v4/api/mass-actions/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/orchestration/v4/api/mass-actions/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([
'filter' => [
'sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'team_sid' => [
'eq' => '<string>'
],
'target_entity' => [
'eq' => '<string>',
'ne' => '<string>',
'in' => [
'<string>'
],
'nin' => [
'<string>'
]
],
'status' => [
'in' => [
]
],
'paused_reason' => [
'in' => [
],
'is_null' => true
],
'hold_till' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>',
'is_null' => true
],
'canary_satisfied_at' => [
'gte' => '<string>',
'lte' => '<string>',
'is_null' => true
],
'started_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>',
'is_null' => true
],
'settled_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>',
'is_null' => true
],
'created_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
],
'updated_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
],
'deleted_at' => [
'gte' => '<string>',
'lte' => '<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/orchestration/v4/api/mass-actions/metrics"
payload := strings.NewReader("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"team_sid\": {\n \"eq\": \"<string>\"\n },\n \"target_entity\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"status\": {\n \"in\": []\n },\n \"paused_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"hold_till\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"canary_satisfied_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"started_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"settled_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"updated_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\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/orchestration/v4/api/mass-actions/metrics")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"team_sid\": {\n \"eq\": \"<string>\"\n },\n \"target_entity\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"status\": {\n \"in\": []\n },\n \"paused_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"hold_till\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"canary_satisfied_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"started_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"settled_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"updated_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/orchestration/v4/api/mass-actions/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 \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"team_sid\": {\n \"eq\": \"<string>\"\n },\n \"target_entity\": {\n \"eq\": \"<string>\",\n \"ne\": \"<string>\",\n \"in\": [\n \"<string>\"\n ],\n \"nin\": [\n \"<string>\"\n ]\n },\n \"status\": {\n \"in\": []\n },\n \"paused_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"hold_till\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"canary_satisfied_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"started_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"settled_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"updated_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "metrics",
"metrics": {
"filter": {},
"period": {
"from": "<string>",
"to": "<string>"
},
"aggregated": {
"counts": {},
"metrics": {
"items_by_status": {},
"items_by_current_step": {},
"items_by_wait_reason": {},
"in_flight": 123,
"next_scheduled_at": "<string>",
"last_scheduled_at": "<string>",
"credits_spent": 123,
"created_objects": {},
"top_errors": [
{
"prefix": "<string>",
"count": 123
}
]
}
},
"metrics": {
"items_by_status": {},
"items_by_current_step": {},
"items_by_wait_reason": {},
"in_flight": 123,
"next_scheduled_at": "<string>",
"last_scheduled_at": "<string>",
"credits_spent": 123,
"created_objects": {},
"top_errors": [
{
"prefix": "<string>",
"count": 123
}
]
}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
},
"applied_filters": {}
}{
"success": false,
"error": {
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"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,
"debug_url": "<string>"
}
}{
"success": false,
"error": {
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"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,
"debug_url": "<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_mass_actions_metrics.
Show child attributes
Show child attributes
⌘I