Insights

List coverage gap employees

GET/v1/insights/coverage-gaps/employees

Returns the people behind uncoveredCount in Get coverage gaps: employees who have the date, but whom no program reaches on that occasion.

Needs a key with the reward:read scope.

Query parameters

occasionstring
Which coverage to list.
limitinteger1 to 100 · Default 50
How many to return, up to 100.
cursorstring
The nextCursor from the previous page. Leave it out to start from the beginning.

200: One page of employees.

dataarray of objects
Employees with this date that no program reaches, ordered by ID.
nextCursorstring or null
Pass this as cursor to get the next page. null on the last page. Treat it as opaque.

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.

Get coverage gaps

Who no birthday or anniversary program reaches.

Get quiet employees

Who has gone a long time without a reward.

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

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

{
  "data": [
    {
      "id": "emp_YY4BTQjWrhH4sQL1dRwjTpBw",
      "fullName": "Grace Hopper"
    }
  ],
  "nextCursor": null
}