v1
latestOpenAPI 3.1.02026-07-2637098.0 KBGet all budgets
Retrieves all synthetic performance budgets for a team, and the data used to evaluate the budget. This endpoint will only retrieve budgets from dashboards that are visible to the entire team. Budgets in private dashboards are not included in the response.
get/budgets
Query parameters
deploy_idinteger
Only retrieve performance budgets that are affected by a certain deploy ID.
Response
200
Example response
{
"budgets": [
{
"budget_id": 31,
"metric": "speedindex",
"metric_full_name": "SpeedIndex",
"metric_type": "SYN",
"metric_suffix": "s",
"absolute_threshold": 1.5,
"alert_after_n_tests": 3,
"modified_at": 1517802795,
"created_at": 1517802795,
"notifications_enabled": true,
"chart": {
"chart_id": 28,
"title": "Chrome speedindex for each region",
"chart_type": "timeseries",
"metric": [
"SYN|speedindex"
],
"correlation_stat": "average",
"stat": "average",
"site_ids": [
299
],
"label": [
"all"
],
"region": [
"each"
],
"test_profile_name": [
"Chrome"
],
"dashboard": {
"dashboard_id": 6,
"name": "Guardian Perf Budgets"
}
},
"status": "over",
"largest_crossing": {
"status": "over",
"name": "SpeedIndex (Syn), Guardian, Australia, Chrome",
"latest_data": [
{
"x": 1632535200,
"y": 4.91,
"aggregated_test_count": 5
}
],
"difference_from_threshold": 3.0533333333333332
},
"crossings": [
{
"status": "over",
"name": "SpeedIndex (Syn), Guardian, Australia, Chrome",
"latest_data": [
{
"x": 1632535200,
"y": 4.91,
"aggregated_test_count": 5
}
],
"difference_from_threshold": 3.0533333333333332
}
]
}
],
"links": {
"self": "http://api.speedcurve.com/v1/budgets",
"next": "http://api.speedcurve.com/v1/budgets/?page=2&limit=10",
"last": "http://api.speedcurve.com/v1/budgets/?page=2&limit=10"
},
"total": 11
}