POST api/v1/Dashboards/filters
Get Dashboard Filters. This is an asynchronous service.
Request Information
URI Parameters
None.
Body Parameters
MetricsFilter| Name | Description | Type | Additional information |
|---|---|---|---|
| DashboardId | globally unique identifier |
None. |
|
| Facilities | Collection of integer |
None. |
|
| Clusters | Collection of integer |
None. |
|
| Departments | Collection of integer |
None. |
|
| StartDateTime | date |
None. |
|
| EndDateTime | date |
None. |
|
| CurrentDateTime | date |
None. |
|
| SortFields | Collection of string |
None. |
|
| UserId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"DashboardId": "d9a47ead-bb1a-47b7-b4ee-ec057f41b500",
"Facilities": [
1,
2
],
"Clusters": [
1,
2
],
"Departments": [
1,
2
],
"StartDateTime": "2026-01-02T16:17:36.6457086-06:00",
"EndDateTime": "2026-01-02T16:17:36.6457086-06:00",
"CurrentDateTime": "2026-01-02T16:17:36.6457086-06:00",
"SortFields": [
"sample string 1",
"sample string 2"
],
"UserId": 1
}
Response Information
Resource Description
ApiResponseModelOfListOfFilterModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | ApiResponseDataModelOfListOfFilterModel |
None. |
|
| Errors | Collection of string |
None. |
|
| Warnings | Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"PageSize": 1,
"Page": 2,
"TotalPages": 3,
"TotalResults": 4,
"Results": [
{
"StartDateTime": "2026-01-02T16:17:36.6457086-06:00",
"EndDateTime": "2026-01-02T16:17:36.6457086-06:00",
"CurrentDateTime": "2026-01-02T16:17:36.6457086-06:00",
"Groups": [
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
},
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
}
],
"Divisions": [
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
},
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
}
],
"Markets": [
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
},
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
}
],
"Facilities": [
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
},
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
}
],
"Clusters": [
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
},
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
}
],
"Departments": [
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
},
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
}
],
"Summaries": [
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
},
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
}
]
},
{
"StartDateTime": "2026-01-02T16:17:36.6457086-06:00",
"EndDateTime": "2026-01-02T16:17:36.6457086-06:00",
"CurrentDateTime": "2026-01-02T16:17:36.6457086-06:00",
"Groups": [
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
},
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
}
],
"Divisions": [
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
},
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
}
],
"Markets": [
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
},
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
}
],
"Facilities": [
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
},
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
}
],
"Clusters": [
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
},
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
}
],
"Departments": [
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
},
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
}
],
"Summaries": [
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
},
{
"ParentValue": "sample string 1",
"GuidValue": "sample string 2",
"SortOrder": "sample string 3",
"FacilityId": "sample string 4",
"Value": "sample string 5",
"Text": "sample string 6"
}
]
}
]
},
"Errors": [
"sample string 1",
"sample string 2"
],
"Warnings": [
"sample string 1",
"sample string 2"
]
}