GEgetsales
companies

Companies metrics

Period-bound aggregates over a filtered company scope (reads ES - never for money decisions). aggregated.counts = "now" composition (total, with_linkedin/with_domain, groups by status / playtable_sids / data_source_sid / signals); metrics = added_count, deleted_count, linkedin/domain coverage rates. period {from,to} required, half-open; period column created_at - its filter operators are ignored. group_by → one groups[] entry per axis value (cap 500). Per-table badges ride playtables metrics.

Contract:

  • MCP tool get_companies_metrics, registry package mcp.playtables/companies, mount playtables.people.
  • Operation metrics, response envelope metrics.
  • Flags: read only.
post/api/companies/metrics

Request

  • Base URL
    https://beta.getsales.io/playtables/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Request body

group_by'status' | 'playtable_sids' | 'data_source_sid' | 'pipeline_stage_sid'

Single-axis breakdown - one groups[] entry per value. Cap 500 groups (422 on overflow - narrow the filter).

Response

metrics success envelope.

successtrue required
operation'metrics' required
applied_filtersobject

Changes

No recorded changes to this operation across all 1 revision of this API.