> ## 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. # 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. ## OpenAPI ````yaml /api-reference/orchestration/openapi.yaml post /api/mass-actions/metrics openapi: 3.0.3 info: title: 'GTM API public contract: gtm.service.orchestration' description: >- The cross-service execution plane: the platform-wide webhook registry and delivery log, plus mass actions (preview, commit, pace, pause, resume, canary) and their per-item child rows. 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.orchestration`, 21 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/orchestration/v4 description: Production, through the app.gtm-api.com gateway - url: http://localhost:8025 description: Local Docker (gtm_orchestration_nginx_dev) security: - BearerJwt: [] TeamSid: [] tags: - name: mass_action_items description: >- Registry package `mcp.orchestration/mass_action_items`, served on MCP mount `orchestration.mass_actions`. - name: mass_actions description: >- Registry package `mcp.orchestration/mass_actions`, served on MCP mount `orchestration.mass_actions`. - name: webhook_logs description: >- Registry package `mcp.orchestration/webhook_logs`, served on MCP mount `orchestration.webhooks`. - name: webhooks description: >- Registry package `mcp.orchestration/webhooks`, served on MCP mount `orchestration.webhooks`. paths: /api/mass-actions/metrics: post: tags: - mass_actions summary: Mass-action metrics description: >- 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. operationId: get_mass_actions_metrics requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/GetMassActionsMetricsRequest' responses: '200': description: '`metrics` success envelope.' content: application/json: schema: $ref: '#/components/schemas/GetMassActionsMetricsResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: GetMassActionsMetricsRequest: type: object description: Request body of `get_mass_actions_metrics`. properties: filter: type: object properties: sid: type: object properties: eq: type: string in: type: array items: type: string additionalProperties: false team_sid: type: object properties: eq: type: string additionalProperties: false description: Auto-applied from the JWT scope; not overridable. target_entity: type: object properties: eq: type: string ne: type: string in: type: array items: type: string nin: type: array items: type: string additionalProperties: false status: type: object properties: eq: type: string enum: - active - paused in: type: array items: type: string enum: - active - paused additionalProperties: false paused_reason: type: object properties: eq: type: string enum: - manual - limit_reached - account_unavailable - canary_failed - other in: type: array items: type: string enum: - manual - limit_reached - account_unavailable - canary_failed - other is_null: type: boolean additionalProperties: false hold_till: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string is_null: type: boolean additionalProperties: false canary_satisfied_at: type: object properties: gte: type: string lte: type: string is_null: type: boolean additionalProperties: false description: is_null:true = the canary gate is still closed. started_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string is_null: type: boolean additionalProperties: false settled_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string is_null: type: boolean additionalProperties: false created_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false updated_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false deleted_at: type: object properties: gte: type: string lte: type: string is_null: type: boolean additionalProperties: false description: >- Omit for live runs only; send any operator to bring stopped (soft-deleted) runs into scope. GetMassActionsMetricsResponse: 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: items_by_status: type: object additionalProperties: type: number items_by_current_step: type: object additionalProperties: type: number items_by_wait_reason: type: object additionalProperties: type: number in_flight: type: number next_scheduled_at: type: string nullable: true last_scheduled_at: type: string nullable: true credits_spent: type: number created_objects: type: object additionalProperties: type: number top_errors: type: array items: type: object properties: prefix: type: string count: type: number required: - prefix - count required: - items_by_status - items_by_current_step - items_by_wait_reason - in_flight - next_scheduled_at - last_scheduled_at - credits_spent - created_objects - top_errors metrics: type: object properties: items_by_status: type: object additionalProperties: type: number items_by_current_step: type: object additionalProperties: type: number items_by_wait_reason: type: object additionalProperties: type: number in_flight: type: number next_scheduled_at: type: string nullable: true last_scheduled_at: type: string nullable: true credits_spent: type: number created_objects: type: object additionalProperties: type: number top_errors: type: array items: type: object properties: prefix: type: string count: type: number required: - prefix - count required: - items_by_status - items_by_current_step - items_by_wait_reason - in_flight - next_scheduled_at - last_scheduled_at - credits_spent - created_objects - top_errors 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. ````