Pipeline totals and win rate

GEThttps://server.heyrik.com/api/v1/leads/summary

Headers

AuthorizationstringRequired

Use Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.

Get your API key

Response

Explore the example values. This is not a complete response schema.

dataobject

Explore 6 properties

totalnumber

Example 428

by_stageobject

Explore 3 properties

newnumber

Example 120

qualifiednumber

Example 88

wonnumber

Example 41

wonnumber

Example 41

win_ratenumber

Example 0.096

total_value_centsnumber

Example 4820000

open_value_centsnumber

Example 3110000

Error reference

GET/leads/summary

cURL

curl https://server.heyrik.com/api/v1/leads/summary \
  -H "Authorization: Bearer $HEYRIK_API_KEY"

Response example

JSON

{
  "data": {
    "total": 428,
    "by_stage": { "new": 120, "qualified": 88, "won": 41 },
    "won": 41,
    "win_rate": 0.096,
    "total_value_cents": 4820000,
    "open_value_cents": 3110000
  }
}

Illustrative examples · No live request is sent