dashboard:readUser IDRetrieve all groups of the caller's account. Returns the same group list used as filter
options for both NetFlow (/v1/netflow/*) and Dashboard (/v1/reports/*) report endpoints.
Both name and id carry the group name.
Use the id value of each item as the group query parameter when calling report endpoints.
This list does not depend on a time range; start_time, end_time and period are
accepted but ignored (an unusable window is not refused here). If the group list cannot be read, the response is 200 with an
empty items array.
start_timedate-timeStart of the time range in ISO 8601 UTC format. Must be sent together with end_time.
A window is either period, or both start_time and end_time spanning at most
180 days with start_time not after end_time. When none of start_time, end_time
and period is sent, the list is returned empty (200, items: []). A window that is
sent but unusable is 400, with the same messages as /v1/netflow/*: only one of
start_time/end_time (Both start_time and end_time must be provided), start_time
after end_time (start_time cannot be greater than end_time), or a range longer than
180 days (Date range cannot exceed 180 days). A value that is not ISO 8601 is 422.
end_timedate-timeEnd of the time range in ISO 8601 UTC format. Must be sent together with start_time.
The range cannot exceed 180 days; a longer or inverted range is 400.
periodstringPredefined report period. Explicit start_time/end_time take precedence.
todaylast_24_hoursyesterdaylast_7_daysthis_monthlast_monthlast_30_daysthis_quarterlast_quarterthis_yearlast_yearlast_12_monthsGroups filter list retrieved successfully.
HTTP status code
Response message
List of available filter options.
Array of filter options.
A single filter option with a display name and value identifier.
Unique request ID for tracking
Example
{
"status_code": 200,
"message": "Success",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"data": {
"items": [
{
"name": "Test Warehouse",
"id": "Test Warehouse"
},
{
"name": "Fleet Alpha",
"id": "Fleet Alpha"
}
]
}
}Was this page helpful?