CRM

Cohort outcomes: wins/losses, volume onboarded, milestones, effort per win, pipeline

GET
/v1/crm/reports/outcomes

Cohort = records that hit the event in [from, to). Win/loss resolves through each status option's outcome (seed ids won/lost by convention). pipeline is a current snapshot and ignores the range.

Authorization

x-api-key<token>

In: header

Query Parameters

from?integer

Inclusive start of the range (epoch ms).

Range0 <= value
to?integer

Exclusive end of the range (epoch ms).

Range0 <= value
userId?string

Omit = the caller's own metrics. team = one entry per workspace member (owner/admin only). A member id = that member (owner/admin only).

tz?string

IANA zone the day buckets are cut in (default America/New_York).

listId?string

Scope every metric to that list's members and vocabulary. A 1-element alias for listIds — do not pass both.

listIds?string

CSV of list ids to scope to (union, not intersection — a record that's a member of more than one selected list is still counted once in every distinct-record metric and once per day-bucket). A list id the caller can't see is silently dropped, not an error. Do not pass alongside listId.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/crm/reports/outcomes"
{
  "data": {
    "from": 0,
    "pipeline": [
      {
        "label": "string",
        "outcome": "won",
        "records": 0,
        "statusId": "string"
      }
    ],
    "to": 0,
    "users": [
      {
        "effortPerWin": {
          "avgCalls": 0,
          "avgDaysToWin": 0,
          "avgEmails": 0,
          "avgMeetings": 0,
          "avgTouches": 0,
          "wins": 0
        },
        "losses": {
          "records": 0,
          "transitions": 0
        },
        "milestones": {
          "timeToConnect": {
            "avgDays": 0,
            "medianDays": 0,
            "records": 0
          },
          "timeToFirstMeeting": {
            "avgDays": 0,
            "medianDays": 0,
            "records": 0
          },
          "timeToFirstTouch": {
            "avgDays": 0,
            "medianDays": 0,
            "records": 0
          },
          "timeToWin": {
            "avgDays": 0,
            "medianDays": 0,
            "records": 0
          }
        },
        "previous": {
          "effortPerWin": {
            "avgCalls": 0,
            "avgDaysToWin": 0,
            "avgEmails": 0,
            "avgMeetings": 0,
            "avgTouches": 0,
            "wins": 0
          },
          "losses": {
            "records": 0,
            "transitions": 0
          },
          "milestones": {
            "timeToConnect": {
              "avgDays": 0,
              "medianDays": 0,
              "records": 0
            },
            "timeToFirstMeeting": {
              "avgDays": 0,
              "medianDays": 0,
              "records": 0
            },
            "timeToFirstTouch": {
              "avgDays": 0,
              "medianDays": 0,
              "records": 0
            },
            "timeToWin": {
              "avgDays": 0,
              "medianDays": 0,
              "records": 0
            }
          },
          "volumeOnboarded": {
            "buyerSideUnits": 0,
            "buyerSideVolume": 0,
            "records": 0,
            "windows": {
              "r12": {
                "records": 0,
                "units": 0,
                "volume": 0
              },
              "r14": {
                "records": 0,
                "units": 0,
                "volume": 0
              },
              "r6": {
                "records": 0,
                "units": 0,
                "volume": 0
              }
            },
            "withProduction": 0
          },
          "wins": {
            "records": 0,
            "transitions": 0
          },
          "winsByStatus": [
            {
              "label": "string",
              "records": 0,
              "statusId": "string"
            }
          ]
        },
        "userId": "string",
        "volumeOnboarded": {
          "buyerSideUnits": 0,
          "buyerSideVolume": 0,
          "records": 0,
          "windows": {
            "r12": {
              "records": 0,
              "units": 0,
              "volume": 0
            },
            "r14": {
              "records": 0,
              "units": 0,
              "volume": 0
            },
            "r6": {
              "records": 0,
              "units": 0,
              "volume": 0
            }
          },
          "withProduction": 0
        },
        "wins": {
          "records": 0,
          "transitions": 0
        },
        "winsByStatus": [
          {
            "label": "string",
            "records": 0,
            "statusId": "string"
          }
        ]
      }
    ]
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}