dashboard

Aggregate summary of policies, policy sets and evaluations for display on the dashboard

dashboard#metrics

Get metrics about policies, policy sets and evaluations

Request

query Parameters

range	string Default: "30d" The time period over which to aggregate dashboard data. Can be: 24 hours, 7 days or 30 days Enum: "24h" "7d" "30d" Example: range=30d
accountIdentifier	string Default: "" Harness account ID Example: accountIdentifier=eBqAoNchMLKigC_qZ5EdC
orgIdentifier	string Default: "" Harness organization ID Example: orgIdentifier=test-org
projectIdentifier	string Default: "" Harness project ID Example: projectIdentifier=test-project

header Parameters

x-api-key

string

Harness PAT key used to perform authorization

Example: Magni quidem natus.

Responses

200

OK response.

400

BadRequest: Bad Request response.

401

Unauthorized: Unauthorized response.

403

Forbidden: Forbidden response.

404

NotFound: Not Found response.

500

InternalServer: Internal Server Error response.

502

BadGateway: Bad Gateway response.

get/pm/api/v1/dashboard

Request samples

curl
Java
Go

Response samples

application/json

{"aggregates": [{"error": 793292374565649800,
"pass": 7952439296093139000,
"time": 5372466697083487000,
"warning": 1084035802756070100
},
{"error": 793292374565649800,
"pass": 7952439296093139000,
"time": 5372466697083487000,
"warning": 1084035802756070100
}
],
"policy_health": {"total_evaluation_count": 1586567418904594200,
"total_evaluation_entity_count": {"error": 6575232042203289000,
"pass": 6693795997184111000,
"warning": 6980779131913748000
},
"total_policy_count": 1711618585904184300,
"total_policy_set_count": 8265194202066287000,
"total_policy_set_entity_count": {"Consequatur doloribus voluptatem est.": 7647236864312285000,
"Eum commodi quasi aut sapiente.": 3188015681251562500,
"Necessitatibus quasi ut.": 1215199620673400000
}
}
}

➔ Next to examples