Companies
Hire cohorts and how many left within N days
x-api-key<token>
In: header
Path Parameters
nmlsId*string
Company NMLS ID
Query Parameters
period?string
Preset window when from/to are not given (default last12Months). Rolling periods start on the FIRST day of the month N months back and end today; a year is Jan 1 – Dec 31; allTime starts 2017-01-01, the earliest reliable registration data. Also selects the production period for volume/units.
Value in
"2017" | "2018" | "2019" | "2020" | "2021" | "2022" | "2023" | "2024" | "2025" | "2026" | "last3Months" | "last6Months" | "last12Months" | "last14Months" | "last16Months" | "last18Months" | "last24Months" | "yearToDate" | "allTime"from?string
Window start, inclusive (YYYY-MM-DD). Overrides period.
Match
^\d{4}-\d{2}-\d{2}$to?string
Window end, inclusive (YYYY-MM-DD). Overrides period.
Match
^\d{4}-\d{2}-\d{2}$month?string
Drill into one hire cohort (YYYY-MM): data then lists its early departures and recent starts.
Match
^\d{4}-\d{2}$withinDays?integer
An exit within this many days of the start is EARLY (default 90). Also the 'recent start' and incomplete-cohort horizon.
Range
1 <= value <= 730Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/companies/string/early-exits"{
"data": [
{
"city": "string",
"daysAtCompany": 0,
"daysSinceStart": 0,
"endDate": "string",
"kind": "early_departure",
"name": "string",
"nextEmployer": {
"name": "string",
"nmlsId": "string"
},
"nmlsId": "string",
"previousEmployer": {
"name": "string",
"nmlsId": "string"
},
"startDate": "string",
"state": "string",
"trailingUnits": 0,
"trailingVolume": 0
}
],
"monthlyCohorts": [
{
"attritionRate": 0,
"earlyDepartures": 0,
"isIncompleteCohort": true,
"month": "string",
"newHires": 0,
"recentStarts": 0
}
],
"summary": {
"avgDaysBeforeExit": 0,
"earlyAttritionRate": 0,
"riskLevel": "low_sample",
"totalEarlyDepartures": 0,
"totalNewHires": 0
},
"truncated": true,
"window": {
"from": "string",
"to": "string"
},
"withinDays": 0
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string",
"limit": 0,
"size": 0
}