> ## Documentation Index > Fetch the complete documentation index at: https://docs.gtm-api.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /api-reference/id/openapi.yaml post /api/credit-transactions/metrics openapi: 3.0.3 info: title: 'GTM API public contract: gtm.service.id' description: >- Identity, access and money: users, teams and members, API keys, OAuth clients and authorizations, billing products, subscriptions, transactions and payment methods, the credit ledger, notifications, TLS certificates, observability and support requests. GENERATED. This document is projected from the Zod MCP tool registry in `product/mcp/gtm.mcp` (one tool per public endpoint, 1:1). Do not edit it by hand; edit the tool definition and regenerate with `pnpm openapi:public`. Surface: the public `/api` contract of `gtm.service.id`, 77 operations. Internal (`/internal`) and health endpoints are deliberately absent; the code-faithful spec that documents those lives in `product/openapi/gtm.openapi.tech`. Conventions: - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header. - Every success body is an MCP envelope: `success: true` plus one typed `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`, `group_by`, `action`), and a `meta` block with `trace_id` for support. - Every failure is the same `McpError` envelope with a code from a fixed 16-code taxonomy, so a client maps errors once. - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward `cursor`; `page_size: 0` returns counts only. - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`) travel as JSON text and array-valued ones repeat as `name[]=value`. - The MCP-only `_meta` field (usage analytics) never reaches the backend and is not part of this contract. version: '1.0' contact: name: GTM API url: https://gtm-api.com email: support@gtm-api.com license: name: Proprietary url: https://gtm-api.com/license servers: - url: https://app.gtm-api.com/id/v4 description: Production, through the app.gtm-api.com gateway - url: http://localhost:8021 description: Local Docker (gtm_id_nginx_dev) security: - BearerJwt: [] TeamSid: [] tags: - name: account_shares description: Registry package `mcp.id/account_shares`, served on MCP mount `id.access`. - name: api_keys description: Registry package `mcp.id/api_keys`, served on MCP mount `id.access`. - name: billing_payment_methods description: >- Registry package `mcp.id/billing_payment_methods`, served on MCP mount `id.billing`. - name: billing_products description: >- Registry package `mcp.id/billing_products`, served on MCP mount `id.billing`. - name: billing_subscriptions description: >- Registry package `mcp.id/billing_subscriptions`, served on MCP mount `id.billing`. - name: billing_transactions description: >- Registry package `mcp.id/billing_transactions`, served on MCP mount `id.billing`. - name: credit_transactions description: >- Registry package `mcp.id/credit_transactions`, served on MCP mount `id.credits`. - name: notifications description: >- Registry package `mcp.id/notifications`, served on MCP mount `id.platform`. - name: oauth_authorizations description: >- Registry package `mcp.id/oauth_authorizations`, served on MCP mount `id.access`. - name: oauth_clients description: Registry package `mcp.id/oauth_clients`, served on MCP mount `id.access`. - name: observability_requests description: >- Registry package `mcp.id/observability_requests`, served on MCP mount `id.platform`. - name: sessions description: Registry package `mcp.id/sessions`, served on MCP mount `id.identity`. - name: ssl_certificates description: >- Registry package `mcp.id/ssl_certificates`, served on MCP mount `id.platform`. - name: support_requests description: >- Registry package `mcp.id/support_requests`, served on MCP mount `id.platform`. - name: team_members description: Registry package `mcp.id/team_members`, served on MCP mount `id.identity`. - name: teams description: Registry package `mcp.id/teams`, served on MCP mount `id.identity`. - name: users description: Registry package `mcp.id/users`, served on MCP mount `id.identity`. paths: /api/credit-transactions/metrics: post: tags: - credit_transactions summary: Credit transactions metrics description: >- 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. operationId: get_credit_transactions_metrics requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetCreditTransactionsMetricsRequest' responses: '200': description: '`metrics` success envelope.' content: application/json: schema: $ref: '#/components/schemas/GetCreditTransactionsMetricsResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: GetCreditTransactionsMetricsRequest: type: object description: Request body of `get_credit_transactions_metrics`. properties: filter: type: object properties: sid: type: object properties: eq: type: string in: type: array items: type: string additionalProperties: false kind: type: object properties: eq: type: string enum: - enrichment in: type: array items: type: string enum: - enrichment additionalProperties: false type: type: object properties: eq: type: string enum: - allocation - debit - refund - expiry ne: type: string enum: - allocation - debit - refund - expiry in: type: array items: type: string enum: - allocation - debit - refund - expiry nin: type: array items: type: string enum: - allocation - debit - refund - expiry additionalProperties: false status: type: object properties: eq: type: string enum: - pending - confirmed - released - expired ne: type: string enum: - pending - confirmed - released - expired in: type: array items: type: string enum: - pending - confirmed - released - expired nin: type: array items: type: string enum: - pending - confirmed - released - expired additionalProperties: false operation: type: object properties: eq: type: string in: type: array items: type: string is_null: type: boolean additionalProperties: false description: >- What consumed credits, e.g. "enrich_profile"; is_null:true = allocation/expiry rows. reference_sid: type: object properties: eq: type: string in: type: array items: type: string is_null: type: boolean additionalProperties: false description: Reverse lookup from an er_… enrich_request or bl_tx_… Paddle tx. request_id: type: object properties: eq: type: string in: type: array items: type: string is_null: type: boolean additionalProperties: false description: Charge-idempotency key lookup. created_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false confirmed_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string is_null: type: boolean additionalProperties: false period: type: object properties: from: type: string description: ISO 8601 UTC window start (inclusive). to: type: string description: ISO 8601 UTC window end (exclusive); must be ≥ from. required: - from - to description: Required metrics window [from, to). group_by: type: string enum: - type - status - operation description: Optional single split axis. required: - period GetCreditTransactionsMetricsResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - metrics metrics: type: object properties: filter: type: object additionalProperties: {} period: type: object properties: from: type: string to: type: string required: - from - to aggregated: type: object properties: counts: type: object additionalProperties: {} metrics: type: object properties: spent: type: integer granted: type: integer refunded: type: integer expired: type: integer net_change: type: integer debit_count: type: integer required: - spent - granted - refunded - expired - net_change - debit_count metrics: type: object properties: spent: type: integer granted: type: integer refunded: type: integer expired: type: integer net_change: type: integer debit_count: type: integer required: - spent - granted - refunded - expired - net_change - debit_count applied_filters: type: object additionalProperties: {} meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. debug_url: type: string description: Deep link to the post-call analysis UI. required: - trace_id - span_id - timestamp - duration_ms - debug_url required: - success - operation - metrics - meta McpError: type: object properties: success: type: boolean enum: - false error: type: object properties: code: type: string enum: - validation_failed - nothing_to_update - not_found - relation_not_found - invalid_transition - limit_exceeded - payment_required - duplicate_rejected - conflict - delete_blocked - unauthorized - forbidden - rate_limited - internal_error - service_unavailable - not_implemented message: type: string recoverable: type: boolean suggestion: type: string field_errors: type: object additionalProperties: type: array items: anyOf: - type: string - type: object properties: rule: type: string message: type: string required: - rule - message blockers: type: array items: type: object properties: type: type: string description: >- Machine-readable blocker type (active_flow, pending_tasks, …). severity: type: string enum: - hard - soft description: >- hard = external action required; soft = acknowledge is enough. description: type: string entity_sid: type: string nullable: true count: type: integer resolution: type: string description: 'Hard: tool name to call. Soft: code for acknowledge[].' resolution_hint: type: string required: - type - severity - description - entity_sid - resolution - resolution_hint context: type: object additionalProperties: {} required: - code - message - recoverable meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. debug_url: type: string description: Deep link to the post-call analysis UI. required: - trace_id - span_id - timestamp - duration_ms - debug_url required: - success - error responses: McpClientError: description: >- MCP error envelope. `error.code` is one of validation_failed, nothing_to_update, not_found, relation_not_found, invalid_transition, limit_exceeded, payment_required, duplicate_rejected, conflict, delete_blocked, unauthorized, forbidden, rate_limited, not_implemented. content: application/json: schema: $ref: '#/components/schemas/McpError' McpServerError: description: >- MCP error envelope with `error.code` internal_error or service_unavailable. content: application/json: schema: $ref: '#/components/schemas/McpError' securitySchemes: BearerJwt: type: http scheme: bearer bearerFormat: JWT description: >- 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. TeamSid: type: apiKey in: header name: Team-SID description: >- Team scope for tokens that do not carry one. Ignored when the token already names a team. ````