Retrieve Account health snapshots with the Unison Public API

Account health snapshots provide the calculated health result for an Account and score model at a point in time. Use them for reporting, trend analysis, or combining Unison health with data in another system.

List Account health snapshots

curl "https://public-api.us.unison.totango.com/v1/account-health-snapshots?page[limit]=20" \
  --header "Authorization: Bearer <public_api_credential>"

The default page size is 20 snapshots and the maximum is 50. Use page[cursor] to request the next page.

Understand snapshot fields

FieldDescription
idThe snapshot ID.
account_idThe related Unison Account ID.
account_external_idsIdentifiers supplied for the Account by connected source systems.
score_model_idThe score model used for the calculation.
scoreThe calculated numeric score.
health_categoryThe resulting health category.
calculated_atWhen the health value was calculated.
updated_atWhen the snapshot was last updated.
profileAdditional score profile information returned with the snapshot.

Join snapshots to Accounts

Use account_id to join a snapshot to the Account returned by GET /v1/accounts. Use account_external_ids when you need to match the Account to an identifier from a source system.

FAQs

Does a snapshot recalculate health?

No. The endpoint returns calculated data from Unison. It does not run or change a score model.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request