Credit spend by day
curl --request POST \
--url https://beta.getsales.io/id/v1/api/credit-transactions/metrics \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"period": {
"from": "<string>",
"to": "<string>"
},
"filter": {
"kind": "platform",
"operation": "<string>",
"feature": "<string>",
"object_sid": "<string>",
"container_sid": "<string>",
"actor_sid": "<string>"
}
}
'import requests
url = "https://beta.getsales.io/id/v1/api/credit-transactions/metrics"
payload = {
"period": {
"from": "<string>",
"to": "<string>"
},
"filter": {
"kind": "platform",
"operation": "<string>",
"feature": "<string>",
"object_sid": "<string>",
"container_sid": "<string>",
"actor_sid": "<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: {
kind: 'platform',
operation: '<string>',
feature: '<string>',
object_sid: '<string>',
container_sid: '<string>',
actor_sid: '<string>'
}
})
};
fetch('https://beta.getsales.io/id/v1/api/credit-transactions/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://beta.getsales.io/id/v1/api/credit-transactions/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' => [
'kind' => 'platform',
'operation' => '<string>',
'feature' => '<string>',
'object_sid' => '<string>',
'container_sid' => '<string>',
'actor_sid' => '<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://beta.getsales.io/id/v1/api/credit-transactions/metrics"
payload := strings.NewReader("{\n \"period\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n \"filter\": {\n \"kind\": \"platform\",\n \"operation\": \"<string>\",\n \"feature\": \"<string>\",\n \"object_sid\": \"<string>\",\n \"container_sid\": \"<string>\",\n \"actor_sid\": \"<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://beta.getsales.io/id/v1/api/credit-transactions/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 \"kind\": \"platform\",\n \"operation\": \"<string>\",\n \"feature\": \"<string>\",\n \"object_sid\": \"<string>\",\n \"container_sid\": \"<string>\",\n \"actor_sid\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/id/v1/api/credit-transactions/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 \"kind\": \"platform\",\n \"operation\": \"<string>\",\n \"feature\": \"<string>\",\n \"object_sid\": \"<string>\",\n \"container_sid\": \"<string>\",\n \"actor_sid\": \"<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": 1,
"groups": {
"type": {},
"status": {},
"operation": {},
"created_date": {},
"product": {},
"feature": {},
"object_sid": {},
"container_sid": {},
"actor_sid": {},
"started_by": {}
}
},
"metrics": {
"spent": 1,
"granted": 1,
"expired": 1,
"charged": 1
}
},
"filter": {},
"groups": [
{
"key": "<string>",
"counts": {
"total_count": 1,
"groups": {
"type": {},
"status": {},
"operation": {},
"created_date": {},
"product": {},
"feature": {},
"object_sid": {},
"container_sid": {},
"actor_sid": {},
"started_by": {}
}
},
"metrics": {
"spent": 1,
"granted": 1,
"expired": 1,
"charged": 1
}
}
]
},
"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>"
}
}credit_transactions
Credit spend by day
The workspace’s credit spend over a REQUIRED period: spent (the confirmed debits), charged (their count, the units of work), granted and expired, counted by type, status, operation, day, product, feature, thing, container, person and starter. group_by created_date is the burn per day; filter.product with group_by container_sid reads a product by its tables or sender profiles, object_sid a table by its columns, actor_sid the people. The balance now is get_credit_lots_metrics.
Contract:
- MCP tool
get_credit_transactions_metrics, registry packagemcp.id/credit_transactions, mountid.billing. - Operation
metrics, response envelopemetrics. - Flags: read only.
POST
/
api
/
credit-transactions
/
metrics
Credit spend by day
curl --request POST \
--url https://beta.getsales.io/id/v1/api/credit-transactions/metrics \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"period": {
"from": "<string>",
"to": "<string>"
},
"filter": {
"kind": "platform",
"operation": "<string>",
"feature": "<string>",
"object_sid": "<string>",
"container_sid": "<string>",
"actor_sid": "<string>"
}
}
'import requests
url = "https://beta.getsales.io/id/v1/api/credit-transactions/metrics"
payload = {
"period": {
"from": "<string>",
"to": "<string>"
},
"filter": {
"kind": "platform",
"operation": "<string>",
"feature": "<string>",
"object_sid": "<string>",
"container_sid": "<string>",
"actor_sid": "<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: {
kind: 'platform',
operation: '<string>',
feature: '<string>',
object_sid: '<string>',
container_sid: '<string>',
actor_sid: '<string>'
}
})
};
fetch('https://beta.getsales.io/id/v1/api/credit-transactions/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://beta.getsales.io/id/v1/api/credit-transactions/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' => [
'kind' => 'platform',
'operation' => '<string>',
'feature' => '<string>',
'object_sid' => '<string>',
'container_sid' => '<string>',
'actor_sid' => '<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://beta.getsales.io/id/v1/api/credit-transactions/metrics"
payload := strings.NewReader("{\n \"period\": {\n \"from\": \"<string>\",\n \"to\": \"<string>\"\n },\n \"filter\": {\n \"kind\": \"platform\",\n \"operation\": \"<string>\",\n \"feature\": \"<string>\",\n \"object_sid\": \"<string>\",\n \"container_sid\": \"<string>\",\n \"actor_sid\": \"<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://beta.getsales.io/id/v1/api/credit-transactions/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 \"kind\": \"platform\",\n \"operation\": \"<string>\",\n \"feature\": \"<string>\",\n \"object_sid\": \"<string>\",\n \"container_sid\": \"<string>\",\n \"actor_sid\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/id/v1/api/credit-transactions/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 \"kind\": \"platform\",\n \"operation\": \"<string>\",\n \"feature\": \"<string>\",\n \"object_sid\": \"<string>\",\n \"container_sid\": \"<string>\",\n \"actor_sid\": \"<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": 1,
"groups": {
"type": {},
"status": {},
"operation": {},
"created_date": {},
"product": {},
"feature": {},
"object_sid": {},
"container_sid": {},
"actor_sid": {},
"started_by": {}
}
},
"metrics": {
"spent": 1,
"granted": 1,
"expired": 1,
"charged": 1
}
},
"filter": {},
"groups": [
{
"key": "<string>",
"counts": {
"total_count": 1,
"groups": {
"type": {},
"status": {},
"operation": {},
"created_date": {},
"product": {},
"feature": {},
"object_sid": {},
"container_sid": {},
"actor_sid": {},
"started_by": {}
}
},
"metrics": {
"spent": 1,
"granted": 1,
"expired": 1,
"charged": 1
}
}
]
},
"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 gs.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_credit_transactions_metrics.
Required. Half-open [from, to) window on created_at, the UTC day a movement belongs to (a hold is born at reserve and captured inside its 15 minutes).
Show child attributes
Show child attributes
Scopes the rows the metrics are computed over: the search filter operators. Omit for all rows.
Show child attributes
Show child attributes
One axis: created_date (the burn per UTC day), product, container_sid (tables, sender profiles), object_sid (columns, chats), actor_sid (people), feature, started_by, operation, type or status; adds groups[] with counts and metrics. Cap 500.
Available options:
type, status, operation, created_date, product, feature, object_sid, container_sid, actor_sid, started_by