Insights

Get coverage gaps

GET/v1/insights/coverage-gaps

Shows how many people no birthday or anniversary program reaches, which service years have no reward, how many are missing a date, and which groups have the largest gaps. Custom date programs are not part of coverage. To see who, use List coverage gap employees.

Needs a key with the reward:read scope.

Response

200: The coverage report.

overallPercentinteger
Birthday and anniversary coverage combined: everyone reached on each occasion, divided by twice your active employees, rounded to a whole number. 0 if you have no active employees.
totalEmployeesinteger
Active employees.
birthdayobject
Coverage for birthdays.
anniversaryobject
Coverage for work anniversaries.
groupsarray of objects
Groups with someone uncovered, largest gap first.

Errors

400API_QUERY_INVALID: A query parameter, or an ID in the path, is unknown or not in the right form.
401API_KEY_INVALID: The key is missing, wrong, expired or revoked.
403API_KEY_SCOPE_MISSING: The key is valid but wasn't given the scope this endpoint needs. PLAN_UPGRADE_REQUIRED: Your plan doesn't include the API. COMPANY_CLOSED: Your company has closed its Teambrite account.
429API_KEY_RATE_LIMITED: The key is over 600 requests a minute. COMPANY_RATE_LIMITED: Your company is over its limit of 120 read requests a minute.

List upcoming rewards

Every reward due from today, day by day.

List coverage gap employees

The people no birthday or anniversary program reaches.

Credentials

Stays in this tab and goes only to the Teambrite API. Requests use your real data. Get API key

Request

curl "https://api.teambrite.com/v1/insights/coverage-gaps" \
  -H "Authorization: Bearer $TEAMBRITE_API_KEY"

Response

{
  "overallPercent": 99,
  "totalEmployees": 184,
  "birthday": {
    "percent": 98,
    "hasProgram": true,
    "uncoveredCount": 0,
    "missingDateCount": 3
  },
  "anniversary": {
    "percent": 99,
    "hasProgram": true,
    "uncoveredCount": 1,
    "missingDateCount": 0,
    "uncoveredYears": [
      15,
      20
    ]
  },
  "groups": [
    {
      "groupId": "grp_T6hW3nJqM9xBc2KvLd5Rf8Zp",
      "name": "Engineering",
      "uncoveredBirthday": 0,
      "uncoveredAnniversary": 1
    }
  ]
}