Dashboards
List dashboards
Get a paginated list of dashboards that your account has access to.
get/v2/dashboards
Query parameters
page[size]integer
Example:10
The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]integer
Example:1
Determines which page of the entities to retrieve.
Filters dashboards in the response.
{
"created_at": {
"eq": "2022-03-30T07:20:50Z"
},
"updated_at": {
"eq": "2022-03-30T07:20:50Z"
}
}sortstring
Sorts a collection of dashboards. Supported sort attributes are:
- name
- created_at
- updated_at
The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list.
Example:created_at desc
Response
List of dashboards
Example response
{
"meta": {
"page": {
"number": 1,
"size": 10,
"total": 100
}
},
"data": [
{
"definition": {
"tiles": [
{
"layout": {
"position": {
"col": 3,
"row": 0
},
"size": {
"cols": 3,
"rows": 1
}
},
"definition": {
"query": {
"datasource": "api_usage",
"time_range": {
"type": "relative",
"time_range": "24h",
"tz": "EST"
},
"dimensions": [
"time",
"gateway_service"
],
"filters": [
{
"operator": "in",
"field": "control_plane",
"value": [
"d5ac5d88-efed-4e10-9dfe-0b0a6646c219"
]
}
],
"granularity": "hourly",
"metrics": [
"request_count",
"response_latency_p99"
]
}
}
}
],
"preset_filters": [
{
"operator": "in",
"field": "control_plane",
"value": [
"00000000-0000-0000-0000-000000000000"
]
},
{
"operator": "in",
"field": "ai_request_model",
"value": [
"request_model1"
]
}
]
},
"labels": {
"env": "test"
},
"id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"created_by": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
}