Credit transactions metrics

curl --request POST \
  --url https://app.gtm-api.com/id/v4/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": {
    "sid": {
      "eq": "<string>",
      "in": [
        "<string>"
      ]
    },
    "kind": {
      "eq": "enrichment",
      "in": [
        "enrichment"
      ]
    },
    "type": {
      "in": [],
      "nin": []
    },
    "status": {
      "in": [],
      "nin": []
    },
    "operation": {
      "eq": "<string>",
      "in": [
        "<string>"
      ],
      "is_null": true
    },
    "reference_sid": {
      "eq": "<string>",
      "in": [
        "<string>"
      ],
      "is_null": true
    },
    "request_id": {
      "eq": "<string>",
      "in": [
        "<string>"
      ],
      "is_null": true
    },
    "created_at": {
      "gte": "<string>",
      "lte": "<string>",
      "gt": "<string>",
      "lt": "<string>"
    },
    "confirmed_at": {
      "gte": "<string>",
      "lte": "<string>",
      "gt": "<string>",
      "lt": "<string>",
      "is_null": true
    }
  }
}
'

import requests

url = "https://app.gtm-api.com/id/v4/api/credit-transactions/metrics"

payload = {
    "period": {
        "from": "<string>",
        "to": "<string>"
    },
    "filter": {
        "sid": {
            "eq": "<string>",
            "in": ["<string>"]
        },
        "kind": {
            "eq": "enrichment",
            "in": ["enrichment"]
        },
        "type": {
            "in": [],
            "nin": []
        },
        "status": {
            "in": [],
            "nin": []
        },
        "operation": {
            "eq": "<string>",
            "in": ["<string>"],
            "is_null": True
        },
        "reference_sid": {
            "eq": "<string>",
            "in": ["<string>"],
            "is_null": True
        },
        "request_id": {
            "eq": "<string>",
            "in": ["<string>"],
            "is_null": True
        },
        "created_at": {
            "gte": "<string>",
            "lte": "<string>",
            "gt": "<string>",
            "lt": "<string>"
        },
        "confirmed_at": {
            "gte": "<string>",
            "lte": "<string>",
            "gt": "<string>",
            "lt": "<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>']},
      kind: {eq: 'enrichment', in: ['enrichment']},
      type: {in: [], nin: []},
      status: {in: [], nin: []},
      operation: {eq: '<string>', in: ['<string>'], is_null: true},
      reference_sid: {eq: '<string>', in: ['<string>'], is_null: true},
      request_id: {eq: '<string>', in: ['<string>'], is_null: true},
      created_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'},
      confirmed_at: {
        gte: '<string>',
        lte: '<string>',
        gt: '<string>',
        lt: '<string>',
        is_null: true
      }
    }
  })
};

fetch('https://app.gtm-api.com/id/v4/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://app.gtm-api.com/id/v4/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' => [
        'sid' => [
                'eq' => '<string>',
                'in' => [
                                '<string>'
                ]
        ],
        'kind' => [
                'eq' => 'enrichment',
                'in' => [
                                'enrichment'
                ]
        ],
        'type' => [
                'in' => [
                                
                ],
                'nin' => [
                                
                ]
        ],
        'status' => [
                'in' => [
                                
                ],
                'nin' => [
                                
                ]
        ],
        'operation' => [
                'eq' => '<string>',
                'in' => [
                                '<string>'
                ],
                'is_null' => true
        ],
        'reference_sid' => [
                'eq' => '<string>',
                'in' => [
                                '<string>'
                ],
                'is_null' => true
        ],
        'request_id' => [
                'eq' => '<string>',
                'in' => [
                                '<string>'
                ],
                'is_null' => true
        ],
        'created_at' => [
                'gte' => '<string>',
                'lte' => '<string>',
                'gt' => '<string>',
                'lt' => '<string>'
        ],
        'confirmed_at' => [
                'gte' => '<string>',
                'lte' => '<string>',
                'gt' => '<string>',
                'lt' => '<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/credit-transactions/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    \"kind\": {\n      \"eq\": \"enrichment\",\n      \"in\": [\n        \"enrichment\"\n      ]\n    },\n    \"type\": {\n      \"in\": [],\n      \"nin\": []\n    },\n    \"status\": {\n      \"in\": [],\n      \"nin\": []\n    },\n    \"operation\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"reference_sid\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"request_id\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"created_at\": {\n      \"gte\": \"<string>\",\n      \"lte\": \"<string>\",\n      \"gt\": \"<string>\",\n      \"lt\": \"<string>\"\n    },\n    \"confirmed_at\": {\n      \"gte\": \"<string>\",\n      \"lte\": \"<string>\",\n      \"gt\": \"<string>\",\n      \"lt\": \"<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/id/v4/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    \"sid\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ]\n    },\n    \"kind\": {\n      \"eq\": \"enrichment\",\n      \"in\": [\n        \"enrichment\"\n      ]\n    },\n    \"type\": {\n      \"in\": [],\n      \"nin\": []\n    },\n    \"status\": {\n      \"in\": [],\n      \"nin\": []\n    },\n    \"operation\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"reference_sid\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"request_id\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"created_at\": {\n      \"gte\": \"<string>\",\n      \"lte\": \"<string>\",\n      \"gt\": \"<string>\",\n      \"lt\": \"<string>\"\n    },\n    \"confirmed_at\": {\n      \"gte\": \"<string>\",\n      \"lte\": \"<string>\",\n      \"gt\": \"<string>\",\n      \"lt\": \"<string>\",\n      \"is_null\": true\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.gtm-api.com/id/v4/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    \"sid\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ]\n    },\n    \"kind\": {\n      \"eq\": \"enrichment\",\n      \"in\": [\n        \"enrichment\"\n      ]\n    },\n    \"type\": {\n      \"in\": [],\n      \"nin\": []\n    },\n    \"status\": {\n      \"in\": [],\n      \"nin\": []\n    },\n    \"operation\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"reference_sid\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"request_id\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"created_at\": {\n      \"gte\": \"<string>\",\n      \"lte\": \"<string>\",\n      \"gt\": \"<string>\",\n      \"lt\": \"<string>\"\n    },\n    \"confirmed_at\": {\n      \"gte\": \"<string>\",\n      \"lte\": \"<string>\",\n      \"gt\": \"<string>\",\n      \"lt\": \"<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": {
        "spent": 123,
        "granted": 123,
        "refunded": 123,
        "expired": 123,
        "net_change": 123,
        "debit_count": 123
      }
    },
    "metrics": {
      "spent": 123,
      "granted": 123,
      "refunded": 123,
      "expired": 123,
      "net_change": 123,
      "debit_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>"
  }
}

credit_transactions

Credit transactions metrics

Credit spend/grant metrics over a period (period column = created_at, half-open [from,to)). Returns spent, granted, refunded, expired, net_change and debit_count. filter is the same object as search and every axis is applied. The time axes are the exception worth knowing: created_at / confirmed_at operators are dropped from the period-bound metrics (period is the one window there) but they DO scope the counts block, which carries no period of its own. Optional single group_by (type / status / operation).

Contract:

MCP tool get_credit_transactions_metrics, registry package mcp.id/credit_transactions, mount id.credits.
Operation metrics, response envelope metrics.
Flags: read only.

POST

api

credit-transactions

metrics

Credit transactions metrics

curl --request POST \
  --url https://app.gtm-api.com/id/v4/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": {
    "sid": {
      "eq": "<string>",
      "in": [
        "<string>"
      ]
    },
    "kind": {
      "eq": "enrichment",
      "in": [
        "enrichment"
      ]
    },
    "type": {
      "in": [],
      "nin": []
    },
    "status": {
      "in": [],
      "nin": []
    },
    "operation": {
      "eq": "<string>",
      "in": [
        "<string>"
      ],
      "is_null": true
    },
    "reference_sid": {
      "eq": "<string>",
      "in": [
        "<string>"
      ],
      "is_null": true
    },
    "request_id": {
      "eq": "<string>",
      "in": [
        "<string>"
      ],
      "is_null": true
    },
    "created_at": {
      "gte": "<string>",
      "lte": "<string>",
      "gt": "<string>",
      "lt": "<string>"
    },
    "confirmed_at": {
      "gte": "<string>",
      "lte": "<string>",
      "gt": "<string>",
      "lt": "<string>",
      "is_null": true
    }
  }
}
'

import requests

url = "https://app.gtm-api.com/id/v4/api/credit-transactions/metrics"

payload = {
    "period": {
        "from": "<string>",
        "to": "<string>"
    },
    "filter": {
        "sid": {
            "eq": "<string>",
            "in": ["<string>"]
        },
        "kind": {
            "eq": "enrichment",
            "in": ["enrichment"]
        },
        "type": {
            "in": [],
            "nin": []
        },
        "status": {
            "in": [],
            "nin": []
        },
        "operation": {
            "eq": "<string>",
            "in": ["<string>"],
            "is_null": True
        },
        "reference_sid": {
            "eq": "<string>",
            "in": ["<string>"],
            "is_null": True
        },
        "request_id": {
            "eq": "<string>",
            "in": ["<string>"],
            "is_null": True
        },
        "created_at": {
            "gte": "<string>",
            "lte": "<string>",
            "gt": "<string>",
            "lt": "<string>"
        },
        "confirmed_at": {
            "gte": "<string>",
            "lte": "<string>",
            "gt": "<string>",
            "lt": "<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>']},
      kind: {eq: 'enrichment', in: ['enrichment']},
      type: {in: [], nin: []},
      status: {in: [], nin: []},
      operation: {eq: '<string>', in: ['<string>'], is_null: true},
      reference_sid: {eq: '<string>', in: ['<string>'], is_null: true},
      request_id: {eq: '<string>', in: ['<string>'], is_null: true},
      created_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'},
      confirmed_at: {
        gte: '<string>',
        lte: '<string>',
        gt: '<string>',
        lt: '<string>',
        is_null: true
      }
    }
  })
};

fetch('https://app.gtm-api.com/id/v4/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://app.gtm-api.com/id/v4/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' => [
        'sid' => [
                'eq' => '<string>',
                'in' => [
                                '<string>'
                ]
        ],
        'kind' => [
                'eq' => 'enrichment',
                'in' => [
                                'enrichment'
                ]
        ],
        'type' => [
                'in' => [
                                
                ],
                'nin' => [
                                
                ]
        ],
        'status' => [
                'in' => [
                                
                ],
                'nin' => [
                                
                ]
        ],
        'operation' => [
                'eq' => '<string>',
                'in' => [
                                '<string>'
                ],
                'is_null' => true
        ],
        'reference_sid' => [
                'eq' => '<string>',
                'in' => [
                                '<string>'
                ],
                'is_null' => true
        ],
        'request_id' => [
                'eq' => '<string>',
                'in' => [
                                '<string>'
                ],
                'is_null' => true
        ],
        'created_at' => [
                'gte' => '<string>',
                'lte' => '<string>',
                'gt' => '<string>',
                'lt' => '<string>'
        ],
        'confirmed_at' => [
                'gte' => '<string>',
                'lte' => '<string>',
                'gt' => '<string>',
                'lt' => '<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/credit-transactions/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    \"kind\": {\n      \"eq\": \"enrichment\",\n      \"in\": [\n        \"enrichment\"\n      ]\n    },\n    \"type\": {\n      \"in\": [],\n      \"nin\": []\n    },\n    \"status\": {\n      \"in\": [],\n      \"nin\": []\n    },\n    \"operation\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"reference_sid\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"request_id\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"created_at\": {\n      \"gte\": \"<string>\",\n      \"lte\": \"<string>\",\n      \"gt\": \"<string>\",\n      \"lt\": \"<string>\"\n    },\n    \"confirmed_at\": {\n      \"gte\": \"<string>\",\n      \"lte\": \"<string>\",\n      \"gt\": \"<string>\",\n      \"lt\": \"<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/id/v4/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    \"sid\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ]\n    },\n    \"kind\": {\n      \"eq\": \"enrichment\",\n      \"in\": [\n        \"enrichment\"\n      ]\n    },\n    \"type\": {\n      \"in\": [],\n      \"nin\": []\n    },\n    \"status\": {\n      \"in\": [],\n      \"nin\": []\n    },\n    \"operation\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"reference_sid\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"request_id\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"created_at\": {\n      \"gte\": \"<string>\",\n      \"lte\": \"<string>\",\n      \"gt\": \"<string>\",\n      \"lt\": \"<string>\"\n    },\n    \"confirmed_at\": {\n      \"gte\": \"<string>\",\n      \"lte\": \"<string>\",\n      \"gt\": \"<string>\",\n      \"lt\": \"<string>\",\n      \"is_null\": true\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.gtm-api.com/id/v4/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    \"sid\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ]\n    },\n    \"kind\": {\n      \"eq\": \"enrichment\",\n      \"in\": [\n        \"enrichment\"\n      ]\n    },\n    \"type\": {\n      \"in\": [],\n      \"nin\": []\n    },\n    \"status\": {\n      \"in\": [],\n      \"nin\": []\n    },\n    \"operation\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"reference_sid\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"request_id\": {\n      \"eq\": \"<string>\",\n      \"in\": [\n        \"<string>\"\n      ],\n      \"is_null\": true\n    },\n    \"created_at\": {\n      \"gte\": \"<string>\",\n      \"lte\": \"<string>\",\n      \"gt\": \"<string>\",\n      \"lt\": \"<string>\"\n    },\n    \"confirmed_at\": {\n      \"gte\": \"<string>\",\n      \"lte\": \"<string>\",\n      \"gt\": \"<string>\",\n      \"lt\": \"<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": {
        "spent": 123,
        "granted": 123,
        "refunded": 123,
        "expired": 123,
        "net_change": 123,
        "debit_count": 123
      }
    },
    "metrics": {
      "spent": 123,
      "granted": 123,
      "refunded": 123,
      "expired": 123,
      "net_change": 123,
      "debit_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

Authorization

string

header

required

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-SID

string

header

required

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.

period

object

required

Required metrics window [from, to).

Show child attributes

filter

object

Show child attributes

group_by

enum<string>

Optional single split axis.

Available options:

type,

status,

operation

Response

metrics success envelope.

success

enum<boolean>

required

Available options:

true

operation

enum<string>

required

Available options:

metrics

metrics

object

required

Show child attributes

Overview

LinkedIn API

ID and Teams API

Orchestration API

Credit transactions metrics

Authorizations

Body

Response