GET
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
anomalies
curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/anomalies \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "amount": 42.42,
    "anomaly_score": 0.5,
    "currency": "USD",
    "heron_id": "txn_aEGijdNkLyC8aRa9TVDrbU",
    "reference_id": "1342db06-feb7-4c33-a157-4351d74a98e9"
  }
]

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

end_user_id_or_heron_id
string
required

The end_user_id or heron_id of EndUser to upload

Query Parameters

category_label_or_heron_id
string
required

Label or Heron ID of category to find anomalies for

Example:

"Revenue"

Response

200 - application/json
OK
amount
number

Converted amount of transaction in currency

Example:

42.42

anomaly_score
number

Anomaly score 0-1, where 1 is very anomalous, and 0 is not anomalous

Example:

0.5

currency
string

Currency code for amount that transaction was converted to

Example:

"USD"

heron_id
string

Heron ID of the Transaction

Example:

"txn_aEGijdNkLyC8aRa9TVDrbU"

reference_id
string

Customer-provided reference ID for the Transaction

Example:

"1342db06-feb7-4c33-a157-4351d74a98e9"