Teambrite
Metrics

Get a metric value

GET/v1/metrics/{id}

Shows how a value you sent was checked against your goal programs, and which of them it rewarded. Poll this after sending a value. Any key with metric:write in your company can read any value your company sent. It doesn't count toward the company read limit.

Needs a key with the metric:write scope.

Path parameters

  • idstring

    The id from Send a metric value.

Response

200: The value and how it was checked.

  • idstring

    The ID of this reading.

  • employeeIdstring

    Who the value belongs to.

  • metricKeystring

    The metric it was sent for.

  • valueinteger

    The value that was sent.

  • statusenum

    pending is recorded and waiting. processing is being checked against your programs. completed is checked. failed means the last check hit a problem on our side, and Teambrite keeps retrying for 24 hours, so there's no need to send it again.

    pendingprocessingcompletedfailed

  • acceptedAtstring

    When Teambrite recorded it.

  • checkedAtstring or null

    When the most recent check against your programs started or finished. null before the first one.

  • programsarray of objects

    Each goal program that was live and included this employee when the value arrived. Empty if there were none.

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.
  • 404METRIC_OBSERVATION_NOT_FOUND: Your company has no metric value with this ID.
  • 429API_KEY_RATE_LIMITED: The key is over 600 requests a minute.

Send a metric value

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

Check API health

A public endpoint for uptime monitors.

Copyright © 2026