> ## 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. # Data sources metrics > The import funnel across data sources: items_collected, promoted, duplicate, stoplisted, disqualified, failed, promotion_rate, last_collected_at over the filtered sources' items in a period (on items.created_at; the filter scopes source rows). group_by status | type | object_type adds groups[] per value: the promotion rate per source type is group_by type. aggregated.counts are source-row counts. One source's live funnel: get_data_source with data_source_items_counts; not the activity feed. Contract: - MCP tool `get_data_sources_metrics`, registry package `mcp.playtables/data_sources`, mount `playtables.sources`. - Operation `metrics`, response envelope `metrics`. - Flags: read only. ## OpenAPI ````yaml /api-reference/playtables/openapi.yaml post /api/data-sources/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/data-sources/metrics: post: tags: - data_sources summary: Data sources metrics description: >- The import funnel across data sources: items_collected, promoted, duplicate, stoplisted, disqualified, failed, promotion_rate, last_collected_at over the filtered sources' items in a period (on items.created_at; the filter scopes source rows). group_by status | type | object_type adds groups[] per value: the promotion rate per source type is group_by type. aggregated.counts are source-row counts. One source's live funnel: get_data_source with data_source_items_counts; not the activity feed. Contract: - MCP tool `get_data_sources_metrics`, registry package `mcp.playtables/data_sources`, mount `playtables.sources`. - Operation `metrics`, response envelope `metrics`. - Flags: read only. operationId: get_data_sources_metrics requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetDataSourcesMetricsRequest' responses: '200': description: '`metrics` success envelope.' content: application/json: schema: $ref: '#/components/schemas/GetDataSourcesMetricsResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: GetDataSourcesMetricsRequest: type: object description: Request body of `get_data_sources_metrics`. properties: filter: type: object properties: sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^ds_sc_ description: Data source sid (ds_sc_…). in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^ds_sc_ description: Data source sid (ds_sc_…). additionalProperties: false description: Prefix-validated ds_sc_ sid(s). 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_ is_null: type: boolean additionalProperties: false description: >- Sources feeding table X; is_null:true = orphaned by playtable deletion. type: type: object properties: eq: type: string enum: - ai_search - sender_search - post_engagement - find_people - csv - webhook in: type: array items: type: string enum: - ai_search - sender_search - post_engagement - find_people - csv - webhook additionalProperties: false description: >- The kind tabs of the sources page: ai_search | sender_search | post_engagement | find_people | csv | webhook. object_type: type: object properties: eq: type: string enum: - people - company in: type: array items: type: string enum: - people - company additionalProperties: false description: 'What the source brings: people | company.' sender_profile_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^ub_sp_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^ub_sp_ is_null: type: boolean additionalProperties: false description: >- Sources run by a given sender profile (ub_sp_…); is_null:true = everything the platform pool or a file feeds. status: type: object properties: eq: type: string enum: - draft - active - paused - completed - failed ne: type: string enum: - draft - active - paused - completed - failed in: type: array items: type: string enum: - draft - active - paused - completed - failed nin: type: array items: type: string enum: - draft - active - paused - completed - failed additionalProperties: false q: type: string maxLength: 128 description: Free text over name only (MySQL LIKE, infix). next_collect_at: type: object properties: gte: type: string lte: type: string is_null: type: boolean additionalProperties: false description: >- Due/overdue scans; ISO 8601. is_null:true = clock-less (csv, webhook, and a bus-served sender search). created_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false description: ISO 8601 range; combine bounds in one object. deleted_at: type: object properties: gte: type: string lte: type: string is_null: type: boolean additionalProperties: false description: 'Default scope is { is_null: true } (live rows).' 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. {from, to} ISO 8601 UTC, half-open: compute the window from the date the client knows (the last 7 days = today minus 7 to now), never from a read. Bounds the funnel by data_source_items.created_at; filter (incl. created_at) scopes source rows. group_by: type: string enum: - status - type - object_type description: >- Single axis - adds groups[] with per-value counts + metrics. Cap 500 groups. required: - period GetDataSourcesMetricsResponse: 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 DataSourceSearchFilter (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: Source rows matching the filter scope. groups: type: object properties: status: anyOf: - type: object additionalProperties: type: number - type: array items: {} type: anyOf: - type: object additionalProperties: type: number - type: array items: {} object_type: anyOf: - type: object additionalProperties: type: number - type: array items: {} required: - status - type - object_type required: - total_count - groups metrics: type: object properties: items_collected: type: integer minimum: 0 description: >- Items created within [period.from, period.to), sources in filter scope. items_promoted: type: integer minimum: 0 description: >- Items whose terminal transition to promoted fell in the period. items_duplicate: type: integer minimum: 0 description: >- Items resolved duplicate in the period (identity ladder matched a live object). items_stoplisted: type: integer minimum: 0 description: Items blocked by a stoplist match in the period. items_disqualified: type: integer minimum: 0 description: >- Items the source gate turned away in the period (2026-10-13). items_failed: type: integer minimum: 0 description: Items whose promotion errored in the period. promotion_rate: type: number nullable: true minimum: 0 maximum: 1 description: >- items_promoted / items_collected; null when items_collected is 0. last_collected_at: type: string nullable: true description: >- MAX(items.created_at) in scope - freshest ingestion; ISO 8601 UTC, null if none. required: - items_collected - items_promoted - items_duplicate - items_stoplisted - items_disqualified - items_failed - promotion_rate - last_collected_at required: - counts - metrics groups: type: array items: type: object properties: key: type: string description: >- Value of the group_by axis (a status / type / object_type value). counts: type: object properties: total_count: type: integer minimum: 0 description: Source rows matching the filter scope. groups: type: object properties: status: anyOf: - type: object additionalProperties: type: number - type: array items: {} type: anyOf: - type: object additionalProperties: type: number - type: array items: {} object_type: anyOf: - type: object additionalProperties: type: number - type: array items: {} required: - status - type - object_type required: - total_count - groups metrics: type: object properties: items_collected: type: integer minimum: 0 description: >- Items created within [period.from, period.to), sources in filter scope. items_promoted: type: integer minimum: 0 description: >- Items whose terminal transition to promoted fell in the period. items_duplicate: type: integer minimum: 0 description: >- Items resolved duplicate in the period (identity ladder matched a live object). items_stoplisted: type: integer minimum: 0 description: Items blocked by a stoplist match in the period. items_disqualified: type: integer minimum: 0 description: >- Items the source gate turned away in the period (2026-10-13). items_failed: type: integer minimum: 0 description: Items whose promotion errored in the period. promotion_rate: type: number nullable: true minimum: 0 maximum: 1 description: >- items_promoted / items_collected; null when items_collected is 0. last_collected_at: type: string nullable: true description: >- MAX(items.created_at) in scope - freshest ingestion; ISO 8601 UTC, null if none. required: - items_collected - items_promoted - items_duplicate - items_stoplisted - items_disqualified - items_failed - promotion_rate - last_collected_at required: - key - counts - metrics description: >- Present only when group_by was set - one entry per axis value. Cap 500 groups → 422. 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.