Skip to main content
POST
Pipeline stages metrics

Authorizations

Authorization
string
header
required

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.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of get_pipeline_stages_metrics.

object
enum<string>
required

Which funnel to count: person (over the people index) or company (over the companies index, which is also what enables deal_sum).

Available options:
person,
company
filter
object

Optional scope: a people filter when object is person, a company filter when it is company (operator objects as on the search tools, e.g. {playtable_sid: {eq: pt_tb_...}}). Omitted = the whole team. deleted_at is ignored: the funnel counts live rows only.

Response

metrics success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
metrics
metrics
object
required

Keyed by stage sid (cr_ps_…), plus a "null" key carrying the objects with no stage. A stage with no objects is absent from the map, not a zero row.

meta
object
required
categories
object
required

The same counts folded per category, every one of the seven present (0 when empty); the "null" bucket folds into none. Read this for "how many are approaching": never fold the stage map yourself.

applied_filters
object