Skip to main content
GET
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
positions
Get positions summary for end user
curl --request GET \
  --url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/positions \
  --header 'x-api-key: <api-key>'
{
  "positions": [
    {
      "group": "<string>",
      "heron_id": "<string>",
      "inflow_metrics": {
        "count": 123,
        "max_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "max_timestamp": "2023-11-07T05:31:56Z",
        "min_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "min_timestamp": "2023-11-07T05:31:56Z",
        "total_amount": {
          "amount": "1234.56",
          "currency": "USD"
        }
      },
      "merchant": "<string>",
      "outflow_metrics": {
        "changed_in_last_90_days": true,
        "count": 123,
        "duration_days": 123,
        "estimated_monthly_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "frequency": "not_enough_data",
        "max_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "max_timestamp": "2023-11-07T05:31:56Z",
        "mean_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "mean_interval_days": 123,
        "min_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "min_timestamp": "2023-11-07T05:31:56Z",
        "mode_interval_days": 123,
        "std_dev_amount": {
          "amount": "1234.56",
          "currency": "USD"
        },
        "total_amount": {
          "amount": "1234.56",
          "currency": "USD"
        }
      },
      "status": "none"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Path Parameters

end_user_id_or_heron_id
string
required

The end user ID or heron ID

Query Parameters

account_ids
string[]

Account IDs to filter positions by

Response

Positions summary retrieved successfully

positions
object[]