CRM

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

getapi.modelmatch.com/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-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

frominteger | null

Inclusive start of the range (epoch ms).

tointeger | null

Exclusive end of the range (epoch ms).

userIdstring

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

tzstring

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

listIdstring

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

listIdsstring

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.

Responses

200objectThe outcomes report.

Show attributes

dataobjectrequired

Show child attributes

fromnumberrequired

pipelineobject[]required

CURRENT snapshot of records by status (ignores from/to and userId).

Show child attributes

labelstringrequired

outcomeenum | nullrequired

Options:wonlostnull

recordsintegerrequired

statusIdstring | nullrequired

tonumberrequired

usersobject[]required

Show child attributes

effortPerWinobjectrequired

lossesobjectrequired

milestonesobjectrequired

previousobjectrequired

userIdstringrequired

volumeOnboardedobjectrequired

winsobjectrequired

winsByStatusobject[]required

400objectValidation error

401objectUnauthorized

403objectForbidden (authenticated, but missing required context — e.g. no active organization)

404objectNot found

413objectResponse payload too large — detail endpoint capped to fit Lambda response limits

503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.

curl -X GET "https://api.modelmatch.com/v1/crm/reports/outcomes" \
  -H "x-api-key: $MODEL_MATCH_API_KEY"

import { createClient, Crm } from "@model-match/api";

createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await Crm.getCrmOutcomesReport();

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/crm/reports/outcomes",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "data": {
    "from": 123.45,
    "pipeline": [
      {
        "label": "<string>",
        "outcome": "won",
        "records": 123,
        "statusId": "<string>"
      }
    ],
    "to": 123.45,
    "users": [
      {
        "effortPerWin": {
          "avgCalls": 123.45,
          "avgDaysToWin": 123.45,
          "avgEmails": 123.45,
          "avgMeetings": 123.45,
          "avgTouches": 123.45,
          "wins": 123
        },
        "losses": {
          "records": 123,
          "transitions": 123
        },
        "milestones": {
          "timeToConnect": {
            "avgDays": 123.45,
            "medianDays": 123.45,
            "records": 123
          },
          "timeToFirstMeeting": {
            "avgDays": 123.45,
            "medianDays": 123.45,
            "records": 123
          },
          "timeToFirstTouch": {
            "avgDays": 123.45,
            "medianDays": 123.45,
            "records": 123
          },
          "timeToWin": {
            "avgDays": 123.45,
            "medianDays": 123.45,
            "records": 123
          }
        },
        "previous": {
          "effortPerWin": {
            "avgCalls": 123.45,
            "avgDaysToWin": 123.45,
            "avgEmails": 123.45,
            "avgMeetings": 123.45,
            "avgTouches": 123.45,
            "wins": 123
          },
          "losses": {
            "records": 123,
            "transitions": 123
          },
          "milestones": {
            "timeToConnect": {
              "avgDays": 123.45,
              "medianDays": 123.45,
              "records": 123
            },
            "timeToFirstMeeting": {
              "avgDays": 123.45,
              "medianDays": 123.45,
              "records": 123
            },
            "timeToFirstTouch": {
              "avgDays": 123.45,
              "medianDays": 123.45,
              "records": 123
            },
            "timeToWin": {
              "avgDays": 123.45,
              "medianDays": 123.45,
              "records": 123
            }
          },
          "volumeOnboarded": {
            "buyerSideUnits": 123.45,
            "buyerSideVolume": 123.45,
            "records": 123,
            "windows": {
              "r12": {
                "records": null,
                "units": null,
                "volume": null
              },
              "r14": {
                "records": null,
                "units": null,
                "volume": null
              },
              "r6": {
                "records": null,
                "units": null,
                "volume": null
              }
            },
            "withProduction": 123
          },
          "wins": {
            "records": 123,
            "transitions": 123
          },
          "winsByStatus": [
            {
              "label": "<string>",
              "records": 123,
              "statusId": "<string>"
            }
          ]
        },
        "userId": "<string>",
        "volumeOnboarded": {
          "buyerSideUnits": 123.45,
          "buyerSideVolume": 123.45,
          "records": 123,
          "windows": {
            "r12": {
              "records": 123,
              "units": 123.45,
              "volume": 123.45
            },
            "r14": {
              "records": 123,
              "units": 123.45,
              "volume": 123.45
            },
            "r6": {
              "records": 123,
              "units": 123.45,
              "volume": 123.45
            }
          },
          "withProduction": 123
        },
        "wins": {
          "records": 123,
          "transitions": 123
        },
        "winsByStatus": [
          {
            "label": "<string>",
            "records": 123,
            "statusId": "<string>"
          }
        ]
      }
    ]
  }
}