Insights

Get program review

GET/v1/insights/program-review

Checks your programs for redundancy: pairs that would pay the same person twice for one occasion, and programs that will never pay anyone.

Needs a key with the reward:read scope.

Response

200: The review.

currencystring
Lowercase three-letter currency code, such as usd.
programCountinteger
Date-based programs reviewed. Metric goal programs are not part of this review.
overlapsarray of objects
Pairs of programs that would pay the same employee twice for one occasion.
idlearray of objects
Programs that will not pay anyone.

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.

Get quiet employees

Who has gone a long time without a reward.

Send a metric value

Report one person's value for a metric, so goal programs can reward them.

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/program-review" \
  -H "Authorization: Bearer $TEAMBRITE_API_KEY"

Response

{
  "currency": "usd",
  "programCount": 3,
  "overlaps": [
    {
      "programs": [
        {
          "id": "pol_V3nQ8dKcR2tYh6LmXw9Zs4Bf",
          "name": "Birthday reward",
          "amountMinor": 2500,
          "audienceCount": 184
        },
        {
          "id": "pol_J7pT2gNbF5vRk8QyCx3Wm6Hd",
          "name": "Engineering birthdays",
          "amountMinor": 1000,
          "audienceCount": 42
        }
      ],
      "occasion": "on their birthday",
      "sharedEmployeeCount": 42,
      "sameAudience": false,
      "doubledMinor": 42000
    }
  ],
  "idle": [
    {
      "id": "pol_Z9rD4sHfL1mPq7VtKn2Gb8Yc",
      "name": "Launch day",
      "reason": "date_passed"
    }
  ]
}