> ## Documentation Index > Fetch the complete documentation index at: https://docs.getsales.io/llms.txt > Use this file to discover all available pages before exploring further. # Credit ledger entries metrics > Credit spend aggregates - THE credits-usage surface: spent (Σ cost) + paid_calls_count over a REQUIRED period (half-open [from,to) on created_at - created_at filter ops ignored), group_by playtable_field_sid | tool_sid | created_date | playtable_sid. Use for: monthly enrichment cost, spend by field/tool/day/table, what run X cost (filter.run_sid). Local receipts - the gtm-api ledger is authoritative billing. Pre-run price → playtable-runs estimate; balance → gs.service.id; line items → search. Contract: - MCP tool `get_credit_ledger_entries_metrics`, registry package `mcp.playtables/credit_ledger_entries`, mount `id.billing`. - Operation `metrics`, response envelope `metrics`. - Flags: read only. ## OpenAPI ````yaml /api-reference/playtables/openapi.yaml post /api/credit-ledger-entries/metrics openapi: 3.0.3 info: title: 'GetSales public contract: gs.service.playtables' description: >- The data platform and the outreach engine: tables of people and companies, their enrichment columns, cells and runs, the data sources that feed them, sender profiles, the stoplist, the activity feed, the credit ledger, and the multichannel workflows with their per-person journeys and tasks. GENERATED. This document is projected from the Zod MCP tool registry in `product/mcp/gs.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 `gs.service.playtables`, 142 operations. This is the only OpenAPI document the platform publishes. Internal (`/internal`) and health endpoints are deliberately absent: they are not part of any contract, they can change without notice, and the service source is their only description. 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: GetSales url: https://getsales.io email: support@getsales.io license: name: Proprietary url: https://getsales.io/terms servers: - url: https://beta.getsales.io/playtables/v1 description: >- Production (the gateway path on the beta ring; the origin is provisioned per DEPLOY_MAP.md) security: - BearerJwt: [] TeamSid: [] tags: - name: activities description: >- Registry package `mcp.playtables/activities`, served on MCP mount `playtables.journeys`. - name: activity_objects description: >- Registry package `mcp.playtables/activity_objects`, served on MCP mount `playtables.people`. - name: companies description: >- Registry package `mcp.playtables/companies`, served on MCP mount `playtables.people`. - name: credit_ledger_entries description: >- Registry package `mcp.playtables/credit_ledger_entries`, served on MCP mount `id.billing`. - name: data_source_items description: >- Registry package `mcp.playtables/data_source_items`, served on MCP mount `playtables.sources`. - name: data_sources description: >- Registry package `mcp.playtables/data_sources`, served on MCP mount `playtables.sources`. - name: notes description: >- Registry package `mcp.playtables/notes`, served on MCP mount `playtables.pipeline`. - name: people description: >- Registry package `mcp.playtables/people`, served on MCP mount `playtables.people`. - name: pipeline_stages description: >- Registry package `mcp.playtables/pipeline_stages`, served on MCP mount `playtables.pipeline`. - name: plays description: >- Registry package `mcp.playtables/plays`, served on MCP mount `playtables.pipeline`. - name: playtable_field_values description: >- Registry package `mcp.playtables/playtable_field_values`, served on MCP mount `playtables.columns`. - name: playtable_fields description: >- Registry package `mcp.playtables/playtable_fields`, served on MCP mount `playtables.columns`. - name: playtable_runs description: >- Registry package `mcp.playtables/playtable_runs`, served on MCP mount `playtables.columns`. - name: playtable_views description: >- Registry package `mcp.playtables/playtable_views`, served on MCP mount `playtables.tables`. - name: playtables description: >- Registry package `mcp.playtables/playtables`, served on MCP mount `playtables.tables`. - name: result_pages description: >- Registry package `mcp.playtables/result_pages`, served on MCP mount `playtables.tables`. - name: sender_profiles description: >- Registry package `mcp.playtables/sender_profiles`, served on MCP mount `playtables.sources`. - name: stoplist_entries description: >- Registry package `mcp.playtables/stoplist_entries`, served on MCP mount `playtables.stoplist`. - name: tags description: >- Registry package `mcp.playtables/tags`, served on MCP mount `playtables.pipeline`. - name: workflow_attachments description: >- Registry package `mcp.playtables/workflow_attachments`, served on MCP mount `playtables.workflows`. - name: workflow_records description: >- Registry package `mcp.playtables/workflow_records`, served on MCP mount `playtables.journeys`. - name: workflow_sources description: >- Registry package `mcp.playtables/workflow_sources`, served on MCP mount `playtables.workflows`. - name: workflow_tasks description: >- Registry package `mcp.playtables/workflow_tasks`, served on MCP mount `playtables.journeys`. - name: workflow_versions description: >- Registry package `mcp.playtables/workflow_versions`, served on MCP mount `playtables.workflows`. - name: workflows description: >- Registry package `mcp.playtables/workflows`, served on MCP mount `playtables.workflows`. paths: /api/credit-ledger-entries/metrics: post: tags: - credit_ledger_entries summary: Credit ledger entries metrics description: >- Credit spend aggregates - THE credits-usage surface: spent (Σ cost) + paid_calls_count over a REQUIRED period (half-open [from,to) on created_at - created_at filter ops ignored), group_by playtable_field_sid | tool_sid | created_date | playtable_sid. Use for: monthly enrichment cost, spend by field/tool/day/table, what run X cost (filter.run_sid). Local receipts - the gtm-api ledger is authoritative billing. Pre-run price → playtable-runs estimate; balance → gs.service.id; line items → search. Contract: - MCP tool `get_credit_ledger_entries_metrics`, registry package `mcp.playtables/credit_ledger_entries`, mount `id.billing`. - Operation `metrics`, response envelope `metrics`. - Flags: read only. operationId: get_credit_ledger_entries_metrics requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetCreditLedgerEntriesMetricsRequest' responses: '200': description: '`metrics` success envelope.' content: application/json: schema: $ref: '#/components/schemas/GetCreditLedgerEntriesMetricsResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: GetCreditLedgerEntriesMetricsRequest: type: object description: Request body of `get_credit_ledger_entries_metrics`. properties: filter: type: object properties: sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^cl_en_ description: Credit ledger entry (receipt) sid (cl_en_…). in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^cl_en_ description: Credit ledger entry (receipt) sid (cl_en_…). additionalProperties: false description: Receipt sid(s), cl_en_ prefix (prefix-validated). playtable_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^pt_tb_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^pt_tb_ additionalProperties: false description: Per-table spend scope (pt_tb_…). object_type: type: object properties: eq: type: string enum: - people - company additionalProperties: false description: 'Residual inside scope: people | company.' object_sid: type: object properties: eq: type: string in: type: array items: type: string additionalProperties: false description: >- cr_pp_… / cr_co_… (mixed prefixes - not prefix-pinned); cell drill-down with playtable_field_sid. playtable_field_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^pt_fd_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^pt_fd_ additionalProperties: false description: Per-field spend scope (pt_fd_…). run_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^pt_rn_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^pt_rn_ is_null: type: boolean additionalProperties: false description: >- What a run cost (pt_rn_…); is_null:true = non-run spend (empty in v1 - the cell-waterfall writer always carries a run). tool_sid: type: object properties: eq: type: string maxLength: 64 in: type: array items: type: string maxLength: 64 additionalProperties: false description: Spend through one gtm-api tool (external sid, opaque). created_by_actor_sid: type: object properties: eq: type: string additionalProperties: false description: >- "What did this person spend" - projected from created_by.actor_sid. idempotency_key: type: object properties: eq: type: string maxLength: 128 additionalProperties: false description: 'Support/debug: locate one exact charge.' created_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false description: >- ISO 8601 range - day windows; combine bounds in one object. Ignored on metrics - period owns the window. description: >- Scopes the rows the metrics are computed over: the search filter operators. Omit for all rows. 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. Half-open [from, to) window on created_at (the receipt clock) - created_at operators inside filter are silently ignored. group_by: type: string enum: - playtable_sid - playtable_field_sid - tool_sid - created_date description: >- Single spend axis: playtable_sid | playtable_field_sid | tool_sid | created_date - adds groups[] with per-value counts + metrics. Cap 500 groups (§4.17). required: - period GetCreditLedgerEntriesMetricsResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - metrics metrics: type: object properties: filter: anyOf: - type: object additionalProperties: {} - type: array items: {} description: >- Echo of the request CreditLedgerEntrySearchFilter (PHP empty map serialises as []). period: type: object properties: from: type: string to: type: string required: - from - to aggregated: type: object properties: counts: type: object properties: total_count: type: integer minimum: 0 description: >- Receipts (paid calls) matching the filter - full filter scope, not the page. groups: type: object properties: playtable_sid: anyOf: - type: object additionalProperties: type: integer minimum: 0 - type: array items: {} description: >- Flat {pt_tb_ sid: call count} - which table is spending. playtable_field_sid: anyOf: - type: object additionalProperties: type: integer minimum: 0 - type: array items: {} description: >- Flat {pt_fd_ sid: call count} - call concentration by field. tool_sid: anyOf: - type: object additionalProperties: type: integer minimum: 0 - type: array items: {} description: >- Flat {tool_sid: call count} - calls through each gtm-api tool. created_date: anyOf: - type: object additionalProperties: type: integer minimum: 0 - type: array items: {} description: >- Flat {'YYYY-MM-DD': call count} - calls per UTC day (≤ 366 values under 12-month retention). required: - playtable_sid - playtable_field_sid - tool_sid - created_date description: >- One axis per CreditLedgerEntryGroupableFieldsEnum value (§4.17). Values are CALL COUNTS - credit sums live in the metrics tool. PHP empty map serialises as []. required: - total_count - groups metrics: type: object properties: spent: type: number minimum: 0 description: >- Σ cost (credits, decimal(12,4)) over receipts in [from, to) at filter scope. paid_calls_count: type: integer minimum: 0 description: >- Receipts (paid calls) in [from, to) - period-bound, unlike counts.total_count (filter scope). required: - spent - paid_calls_count required: - counts - metrics groups: type: array items: type: object properties: key: type: string nullable: true description: >- Value of the group_by axis: a pt_tb_ / pt_fd_ sid, a gtm-api tool_sid, or a 'YYYY-MM-DD' date; null = rows without a value on the axis. counts: type: object properties: total_count: type: integer minimum: 0 description: >- Receipts (paid calls) matching the filter - full filter scope, not the page. groups: type: object properties: playtable_sid: anyOf: - type: object additionalProperties: type: integer minimum: 0 - type: array items: {} description: >- Flat {pt_tb_ sid: call count} - which table is spending. playtable_field_sid: anyOf: - type: object additionalProperties: type: integer minimum: 0 - type: array items: {} description: >- Flat {pt_fd_ sid: call count} - call concentration by field. tool_sid: anyOf: - type: object additionalProperties: type: integer minimum: 0 - type: array items: {} description: >- Flat {tool_sid: call count} - calls through each gtm-api tool. created_date: anyOf: - type: object additionalProperties: type: integer minimum: 0 - type: array items: {} description: >- Flat {'YYYY-MM-DD': call count} - calls per UTC day (≤ 366 values under 12-month retention). required: - playtable_sid - playtable_field_sid - tool_sid - created_date description: >- One axis per CreditLedgerEntryGroupableFieldsEnum value (§4.17). Values are CALL COUNTS - credit sums live in the metrics tool. PHP empty map serialises as []. required: - total_count - groups metrics: type: object properties: spent: type: number minimum: 0 description: >- Σ cost (credits, decimal(12,4)) over receipts in [from, to) at filter scope. paid_calls_count: type: integer minimum: 0 description: >- Receipts (paid calls) in [from, to) - period-bound, unlike counts.total_count (filter scope). required: - spent - paid_calls_count required: - key - counts - metrics description: >- Present only when group_by was set - one entry per axis value in scope. required: - period - aggregated 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. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms 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: 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. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms 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 gs.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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.