> ## 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. # Sender profile stats > What up to 200 sender profiles did, one row per sid. Today: what each LinkedIn account did against its caps (each action type with its hold and why) and the emails sent against the mailboxes' daily limits. The period from..to: the ledger's done sends and visits. The load: journeys and tasks by status. An unknown sid is left out. For "who is out of invites today" and "who is held"; identity and health: search_sender_profiles; one profile's outreach day by day: get_sender_profile_performance. Contract: - MCP tool `read_sender_profile_stats`, registry package `mcp.playtables/sender_profiles`, mount `playtables.sources`. - Operation `action`, response envelope `action`. - Flags: read only. ## OpenAPI ````yaml /api-reference/playtables/openapi.yaml post /api/sender-profiles/stats 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/sender-profiles/stats: post: tags: - sender_profiles summary: Sender profile stats description: >- What up to 200 sender profiles did, one row per sid. Today: what each LinkedIn account did against its caps (each action type with its hold and why) and the emails sent against the mailboxes' daily limits. The period from..to: the ledger's done sends and visits. The load: journeys and tasks by status. An unknown sid is left out. For "who is out of invites today" and "who is held"; identity and health: search_sender_profiles; one profile's outreach day by day: get_sender_profile_performance. Contract: - MCP tool `read_sender_profile_stats`, registry package `mcp.playtables/sender_profiles`, mount `playtables.sources`. - Operation `action`, response envelope `action`. - Flags: read only. operationId: read_sender_profile_stats requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReadSenderProfileStatsRequest' responses: '200': description: '`action` success envelope.' content: application/json: schema: $ref: '#/components/schemas/ReadSenderProfileStatsResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: ReadSenderProfileStatsRequest: type: object description: Request body of `read_sender_profile_stats`. properties: sids: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^ub_sp_ description: >- Sender profile sid (ub_sp_…): the unibox sid, the same on the playtables copy. minItems: 1 maxItems: 200 description: >- The sender profiles to read (ub_sp_…), 1 to 200. The answer holds one row per sid that names a sender profile of the team, in no fixed order; a sid no row answers to is left out, never an error. from: type: string description: >- The period's start: an ISO 8601 date or moment (a date reads as its midnight UTC). The ledger's done sends and profile visits from here on count under `period`; the day blocks, the week and the last action do not depend on it. to: type: string description: >- The period's end: after `from`, at most 367 days after it (the last 12 months fit in any zone). Exclusive. required: - sids - from - to ReadSenderProfileStatsResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - action action: type: string description: kebab-case verb; matches the route segment. item: {} result: type: object properties: sender_profiles: type: array items: type: object properties: sid: type: string description: >- The sender profile the row answers for (ub_sp_…), one of the sids asked. linkedin: type: object nullable: true properties: synced_at: type: string nullable: true description: >- When the pacing mirror last read gtm's counters (ISO 8601 UTC, the latest of the four kinds); null when never synced. invites: type: object properties: done: type: integer minimum: 0 description: >- Done today of this kind, in gtm's day: everything the account did, whoever asked for it. limit: type: integer nullable: true description: >- Today's cap of this kind (gtm's smart limit); null when the pacing mirror holds none. hold: type: boolean description: >- Whether this kind is held right now: the dispatcher sends none of it until hold_until. hold_until: type: string nullable: true description: >- ISO 8601 UTC: when the hold lifts; null while not held. hold_reason: type: string nullable: true description: >- Why it is held: daily_limit_reached (the cap is spent, or gtm reported the day saturated; lifts at gtm's next day), linkedin_limit_hit (LinkedIn itself refused the action: the account is off that kind until the hold lifts) or limit_hold (a hold of another cause); null while not held. required: - done - limit - hold - hold_until - hold_reason description: Connection requests. messages: type: object properties: done: type: integer minimum: 0 description: >- Done today of this kind, in gtm's day: everything the account did, whoever asked for it. limit: type: integer nullable: true description: >- Today's cap of this kind (gtm's smart limit); null when the pacing mirror holds none. hold: type: boolean description: >- Whether this kind is held right now: the dispatcher sends none of it until hold_until. hold_until: type: string nullable: true description: >- ISO 8601 UTC: when the hold lifts; null while not held. hold_reason: type: string nullable: true description: >- Why it is held: daily_limit_reached (the cap is spent, or gtm reported the day saturated; lifts at gtm's next day), linkedin_limit_hit (LinkedIn itself refused the action: the account is off that kind until the hold lifts) or limit_hold (a hold of another cause); null while not held. required: - done - limit - hold - hold_until - hold_reason inmails: type: object properties: done: type: integer minimum: 0 description: >- Done today of this kind, in gtm's day: everything the account did, whoever asked for it. limit: type: integer nullable: true description: >- Today's cap of this kind (gtm's smart limit); null when the pacing mirror holds none. hold: type: boolean description: >- Whether this kind is held right now: the dispatcher sends none of it until hold_until. hold_until: type: string nullable: true description: >- ISO 8601 UTC: when the hold lifts; null while not held. hold_reason: type: string nullable: true description: >- Why it is held: daily_limit_reached (the cap is spent, or gtm reported the day saturated; lifts at gtm's next day), linkedin_limit_hit (LinkedIn itself refused the action: the account is off that kind until the hold lifts) or limit_hold (a hold of another cause); null while not held. required: - done - limit - hold - hold_until - hold_reason visits: type: object properties: done: type: integer minimum: 0 description: >- Done today of this kind, in gtm's day: everything the account did, whoever asked for it. limit: type: integer nullable: true description: >- Today's cap of this kind (gtm's smart limit); null when the pacing mirror holds none. hold: type: boolean description: >- Whether this kind is held right now: the dispatcher sends none of it until hold_until. hold_until: type: string nullable: true description: >- ISO 8601 UTC: when the hold lifts; null while not held. hold_reason: type: string nullable: true description: >- Why it is held: daily_limit_reached (the cap is spent, or gtm reported the day saturated; lifts at gtm's next day), linkedin_limit_hit (LinkedIn itself refused the action: the account is off that kind until the hold lifts) or limit_hold (a hold of another cause); null while not held. required: - done - limit - hold - hold_until - hold_reason description: Profile visits. required: - synced_at - invites - messages - inmails - visits description: >- TODAY on LinkedIn, as the pacing mirror of gtm's smart limits counts it, per action kind against its cap and with its hold; null on a sender profile with no LinkedIn account. email: type: object nullable: true properties: sent: type: integer minimum: 0 description: >- The ledger's email sends done today, in the workspace's timezone. limit: type: integer nullable: true description: >- The sum of the live mailboxes' daily limits; null when no live mailbox states one. mailboxes: type: array items: type: object properties: email_account_sid: type: string description: The mailbox (em_ac_…). sent: type: integer minimum: 0 description: >- Sent today from this mailbox, attributed by the mailbox a done task left from. required: - email_account_sid - sent description: >- Each of the sender profile's mailboxes in the copy's order: the Email tab's "N of M sent". required: - sent - limit - mailboxes description: >- TODAY by email, in the workspace's timezone: the ledger's sends against the sum of the live mailboxes' limits, and per mailbox; null on a sender profile with no mailbox. period: type: object properties: invites: type: integer minimum: 0 messages: type: integer minimum: 0 inmails: type: integer minimum: 0 emails: type: integer minimum: 0 visits: type: integer minimum: 0 required: - invites - messages - inmails - emails - visits description: >- The ledger's done sends and profile visits inside from..to, by kind (by finished_at). week: type: array items: type: object properties: date: type: string description: YYYY-MM-DD in the workspace's timezone. actions: type: integer minimum: 0 description: Every done send-class task of that day. required: - date - actions description: >- The last seven days in the workspace's timezone, oldest first, today last: every done send-class task an action. last_action: type: object nullable: true properties: at: type: string description: 'ISO 8601 UTC: when it finished.' type: type: string enum: - linkedin_send_connection_request - linkedin_send_message - linkedin_send_inmail - linkedin_visit_profile - linkedin_endorse_skills - linkedin_withdraw_connection_request - linkedin_like_latest_post - linkedin_comment_latest_post - email_send - wait - wait_for_event - condition - ab_test - api_call - ask_ai - manual_task - move_to_workflow - add_tag - remove_tag - set_field - change_sender - run_column description: >- What it was: a send-class task (a connection request, a message, an InMail, a profile visit, an endorsement, a withdrawal, a like, a comment or an email); the orchestration-class values of the vocabulary never appear here. required: - at - type description: >- The latest done send-class task of the last 30 days; null past that. workflow_records_counts: type: object properties: total_count: type: integer minimum: 0 groups: type: object properties: status: anyOf: - type: object additionalProperties: type: number - type: array items: {} required: - status required: - total_count - groups description: >- The journeys pinned to this sender profile (WorkflowRecordCounts over sender_profile_sid, full scope): total_count and groups.status, the enrollment funnel (active, waiting, paused_on_reply, waiting_limit, blocked, ...), the live load. See ./workflow_records.md. workflow_tasks_counts: type: object properties: total_count: type: integer minimum: 0 groups: type: object properties: status: anyOf: - type: object additionalProperties: type: number - type: array items: {} required: - status required: - total_count - groups description: >- The tasks that name this sender profile (WorkflowTaskCounts over sender_profile_sid, full scope): total_count and groups.status (pending, scheduled, dispatched, done, failed, ...), the queue shape. See ./workflow_tasks.md. required: - sid - linkedin - email - period - week - last_action - workflow_records_counts - workflow_tasks_counts description: >- One row per sid asked that names a sender profile of the team, in no fixed order. required: - sender_profiles 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 - action - item - result - 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.