> ## 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. # Webhook logs metrics > Period-bound delivery health: success_rate, failure_rate, p50 / p95 / p99 latency, total_retries, last_success_at and last_failure_at. The rates count terminal rows only (a delivery still on its ladder is in counts.groups.status.retrying, not here); a period with nothing terminal reads null. period {from, to} is required; filter is the search filter (created_at inside it is ignored, period is the window); group_by splits by status, event_type, response_code, webhook_sid or account_sid. Contract: - MCP tool `get_webhook_logs_metrics`, registry package `mcp.integrations/webhook_logs`, mount `integrations.webhooks`. - Operation `metrics`, response envelope `metrics`. - Flags: read only. ## OpenAPI ````yaml /api-reference/integrations/openapi.yaml post /api/webhook-logs/metrics openapi: 3.0.3 info: title: 'GetSales public contract: gs.service.integrations' description: >- The integrations service: the integration platform (the team's credentials for its own APIs and its CRM grants, the HTTP tools it defines over them, the execution log and the priced catalog of every outbound provider call) and the event plane (the platform-wide webhook subscriptions and the delivery state of each event). 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.integrations`, 26 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/integrations/v1 description: >- Production (the gateway path on the beta ring; the origin is provisioned per DEPLOY_MAP.md) security: - BearerJwt: [] TeamSid: [] tags: - name: custom_tools description: >- Registry package `mcp.integrations/custom_tools`, served on MCP mount `integrations.providers`. - name: provider_calls description: >- Registry package `mcp.integrations/provider_calls`, served on MCP mount `integrations.providers`. - name: provider_connections description: >- Registry package `mcp.integrations/provider_connections`, served on MCP mount `integrations.providers`. - name: webhook_logs description: >- Registry package `mcp.integrations/webhook_logs`, served on MCP mount `integrations.webhooks`. - name: webhooks description: >- Registry package `mcp.integrations/webhooks`, served on MCP mount `integrations.webhooks`. paths: /api/webhook-logs/metrics: post: tags: - webhook_logs summary: Webhook logs metrics description: >- Period-bound delivery health: success_rate, failure_rate, p50 / p95 / p99 latency, total_retries, last_success_at and last_failure_at. The rates count terminal rows only (a delivery still on its ladder is in counts.groups.status.retrying, not here); a period with nothing terminal reads null. period {from, to} is required; filter is the search filter (created_at inside it is ignored, period is the window); group_by splits by status, event_type, response_code, webhook_sid or account_sid. Contract: - MCP tool `get_webhook_logs_metrics`, registry package `mcp.integrations/webhook_logs`, mount `integrations.webhooks`. - Operation `metrics`, response envelope `metrics`. - Flags: read only. operationId: get_webhook_logs_metrics requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetWebhookLogsMetricsRequest' responses: '200': description: '`metrics` success envelope.' content: application/json: schema: $ref: '#/components/schemas/GetWebhookLogsMetricsResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: GetWebhookLogsMetricsRequest: type: object description: Request body of `get_webhook_logs_metrics`. properties: filter: type: object properties: sid: type: object properties: eq: type: string in: type: array items: type: string additionalProperties: false description: Delivery sid(s). webhook_sid: type: object properties: eq: type: string in: type: array items: type: string additionalProperties: false description: One subscription's deliveries. account_sid: type: object properties: eq: type: string in: type: array items: type: string is_null: type: boolean additionalProperties: false description: One sending identity; is_null true = team-wide events. source_service: type: object properties: eq: type: string in: type: array items: type: string additionalProperties: false description: playtables | unibox | signals | integrations. event_type: type: object properties: eq: type: string ne: type: string in: type: array items: type: string nin: type: array items: type: string additionalProperties: false description: The event type. event_source_sid: type: object properties: eq: type: string in: type: array items: type: string additionalProperties: false description: The row that produced the event. status: type: object properties: eq: type: string enum: - pending - in_progress - retrying - success - failed - cancelled ne: type: string enum: - pending - in_progress - retrying - success - failed - cancelled in: type: array items: type: string enum: - pending - in_progress - retrying - success - failed - cancelled nin: type: array items: type: string enum: - pending - in_progress - retrying - success - failed - cancelled additionalProperties: false description: in [pending, retrying] = still in flight. cancel_reason: type: object properties: eq: type: string enum: - manual - webhook_deleted - webhook_disabled - webhook_failed in: type: array items: type: string enum: - manual - webhook_deleted - webhook_disabled - webhook_failed is_null: type: boolean additionalProperties: false description: Why a row was cancelled. retry_count: type: object properties: eq: type: number ne: type: number gte: type: number lte: type: number gt: type: number lt: type: number additionalProperties: false description: Executed attempts. response_code: type: object properties: eq: type: number ne: type: number gte: type: number lte: type: number gt: type: number lt: type: number is_null: type: boolean additionalProperties: false description: is_null true = no HTTP answer (network, timeout). duration_ms: type: object properties: eq: type: number ne: type: number gte: type: number lte: type: number gt: type: number lt: type: number is_null: type: boolean additionalProperties: false description: The last attempt's latency. scheduled_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false description: ISO 8601 bounds. executed_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string is_null: type: boolean additionalProperties: false description: ISO 8601 bounds; is_null true = never attempted. created_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false description: ISO 8601 bounds. 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). required: - from - to description: Required metrics window. group_by: type: string enum: - status - event_type - response_code - webhook_sid - account_sid description: One split axis; omit for one total. required: - period GetWebhookLogsMetricsResponse: 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: success_rate: type: number nullable: true description: 0..1 over the terminal rows; null when none. failure_rate: type: number nullable: true description: 0..1, the mirror of success_rate. avg_duration_ms: type: number nullable: true description: Mean over timed rows. p50_duration_ms: type: number nullable: true description: Median latency over terminal rows. p95_duration_ms: type: number nullable: true description: 95th percentile. p99_duration_ms: type: number nullable: true description: 99th percentile. total_retries: type: number description: Sum of retry_count over the set. last_success_at: type: string nullable: true description: The latest successful delivery in the window. last_failure_at: type: string nullable: true description: The latest failed delivery in the window. required: - success_rate - failure_rate - avg_duration_ms - p50_duration_ms - p95_duration_ms - p99_duration_ms - total_retries - last_success_at - last_failure_at metrics: type: object properties: success_rate: type: number nullable: true description: 0..1 over the terminal rows; null when none. failure_rate: type: number nullable: true description: 0..1, the mirror of success_rate. avg_duration_ms: type: number nullable: true description: Mean over timed rows. p50_duration_ms: type: number nullable: true description: Median latency over terminal rows. p95_duration_ms: type: number nullable: true description: 95th percentile. p99_duration_ms: type: number nullable: true description: 99th percentile. total_retries: type: number description: Sum of retry_count over the set. last_success_at: type: string nullable: true description: The latest successful delivery in the window. last_failure_at: type: string nullable: true description: The latest failed delivery in the window. required: - success_rate - failure_rate - avg_duration_ms - p50_duration_ms - p95_duration_ms - p99_duration_ms - total_retries - last_success_at - last_failure_at 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.