KPI Tiles

Header KPI tiles, aggregated in the DB (deal_kpis view, or deal_kpis_search when q is set), in display shape.

GET /deals/kpis

Get Deals Kpis

cURL

curl --request GET \
  --url https://api.example.com/deals/kpis \
  --header 'Authorization: Bearer <token>'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Aggregate KPI tiles (total, pipeline, avg close, at-risk), computed in the database (the deal_kpis view, or the deal_kpis_search RPC when q is set to a free-text search string).

Auth

Requires a CRM read scope and an active organization on the token. Any of contacts:read, deals:read, companies:read, or activities:read qualifies, as does any *:manage scope — manage implies read.

Response

Field	Type	Description
total	integer	Total deal count.
pipeline	number	Sum of open deal value.
avgClose	integer | null	Average days-to-close, or null if not computable.
atRisk	integer	Count of at-risk deals.

Note the mixed casing — total/pipeline are lowercase, avgClose/atRisk are camelCase — this is the literal response shape, not a documentation typo.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

q · string | null

Free-text search; when set, KPIs are computed via the deal_kpis_search RPC instead of the deal_kpis view.

Response

200

application/json

Successful Response