curl --request GET \
--url https://app.herondata.io/api/end_users/{heron_id}/policy_evaluations \
--header 'x-api-key: <api-key>'
[
{
"failed_checks": [
{
"attribute_value": {
"attribute_label": "<string>",
"value": "<string>"
},
"check": {
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": true,
"checks": [
{}
],
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "AND"
},
"date_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "greater_than",
"value": {}
},
"name": "<string>",
"numeric_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
},
"sql_check": {
"auto_decline": true,
"column_name": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"query_name": "<string>"
},
"string_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
}
},
"evaluations": [
{}
],
"result": "pass"
}
],
"missing_data_checks": [
{
"attribute_value": {
"attribute_label": "<string>",
"value": "<string>"
},
"check": {
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": true,
"checks": [
{}
],
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "AND"
},
"date_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "greater_than",
"value": {}
},
"name": "<string>",
"numeric_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
},
"sql_check": {
"auto_decline": true,
"column_name": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"query_name": "<string>"
},
"string_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
}
},
"evaluations": [
{}
],
"result": "pass"
}
],
"passed_checks": [
{
"attribute_value": {
"attribute_label": "<string>",
"value": "<string>"
},
"check": {
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": true,
"checks": [
{}
],
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "AND"
},
"date_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "greater_than",
"value": {}
},
"name": "<string>",
"numeric_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
},
"sql_check": {
"auto_decline": true,
"column_name": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"query_name": "<string>"
},
"string_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
}
},
"evaluations": [
{}
],
"result": "pass"
}
],
"policy": {
"checks": [
{
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": true,
"checks": [
{}
],
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "AND"
},
"date_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "greater_than",
"value": {}
},
"name": "<string>",
"numeric_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
},
"sql_check": {
"auto_decline": true,
"column_name": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"query_name": "<string>"
},
"string_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
}
}
],
"display_order": null,
"heron_id": "<string>",
"name": "<string>"
},
"result": "passed"
}
]
Evaluates the user’s policies against end user on-the-fly
curl --request GET \
--url https://app.herondata.io/api/end_users/{heron_id}/policy_evaluations \
--header 'x-api-key: <api-key>'
[
{
"failed_checks": [
{
"attribute_value": {
"attribute_label": "<string>",
"value": "<string>"
},
"check": {
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": true,
"checks": [
{}
],
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "AND"
},
"date_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "greater_than",
"value": {}
},
"name": "<string>",
"numeric_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
},
"sql_check": {
"auto_decline": true,
"column_name": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"query_name": "<string>"
},
"string_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
}
},
"evaluations": [
{}
],
"result": "pass"
}
],
"missing_data_checks": [
{
"attribute_value": {
"attribute_label": "<string>",
"value": "<string>"
},
"check": {
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": true,
"checks": [
{}
],
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "AND"
},
"date_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "greater_than",
"value": {}
},
"name": "<string>",
"numeric_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
},
"sql_check": {
"auto_decline": true,
"column_name": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"query_name": "<string>"
},
"string_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
}
},
"evaluations": [
{}
],
"result": "pass"
}
],
"passed_checks": [
{
"attribute_value": {
"attribute_label": "<string>",
"value": "<string>"
},
"check": {
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": true,
"checks": [
{}
],
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "AND"
},
"date_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "greater_than",
"value": {}
},
"name": "<string>",
"numeric_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
},
"sql_check": {
"auto_decline": true,
"column_name": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"query_name": "<string>"
},
"string_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
}
},
"evaluations": [
{}
],
"result": "pass"
}
],
"policy": {
"checks": [
{
"attribute_label": "<string>",
"boolean_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"value": true
},
"composite_check": {
"auto_decline": true,
"checks": [
{}
],
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "AND"
},
"date_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "2023-12-25"
},
"date_delta_to_now_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "greater_than",
"value": {}
},
"name": "<string>",
"numeric_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
},
"sql_check": {
"auto_decline": true,
"column_name": "<string>",
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"query_name": "<string>"
},
"string_check": {
"auto_decline": true,
"decline_description": "<string>",
"email_template_name": "<string>",
"ignore_metric_availability": true,
"is_mandatory": true,
"pass_description": "<string>",
"type": "equal",
"value": "<string>"
}
}
],
"display_order": null,
"heron_id": "<string>",
"name": "<string>"
},
"result": "passed"
}
]
Ok
The response is of type object[]
.
Was this page helpful?