--- title: "List custom analytics dashboards" method: GET path: "/environments/{envId}/analytics/dashboards" tags: ["dashboards"] --- # List custom analytics dashboards `GET /environments/{envId}/analytics/dashboards` Retrieves a paginated list of all custom analytics dashboards for the current environment. ## Query parameters - `page` integer - `perPage` integer ## Response `200` List of dashboards for the current environment. - DashboardsResponse — Paginated response containing a list of custom analytics dashboards. - `data` Dashboard[] — List of dashboards for the current page - `id` string, required — Unique identifier of the dashboard - `name` string, required — The name of the dashboard - `createdBy` string, required — The identifier of the user who created the dashboard. Deprecated — this field currently returns a raw user ID. In a future version it will be replaced by a structured object with display name and other user metadata. - `createdAt` string, date-time, required — Timestamp when the dashboard was created (ISO 8601) - `lastModified` string, date-time, required — Timestamp when the dashboard was last modified (ISO 8601) - `labels` object — Key-value pairs of labels for organizing and categorizing dashboards. - `widgets` Widget[], required — List of widget definitions in the dashboard - `id` string, required — Unique identifier of the widget within the dashboard - `title` string, required — Display title of the widget - `description` string — Optional description of the widget - `type` 'stats' | 'doughnut' | 'pie' | 'polarArea' | 'time-series-line' | 'time-series-bar' | 'vertical-bar' | 'horizontal-bar', required — The type of widget visualization. - **stats**: A single number KPI / stat widget displaying aggregated values. - **doughnut**: A doughnut chart widget for displaying proportional data. - **pie**: A pie chart widget for displaying proportional data. - **polarArea**: A polar area chart widget for displaying proportional data with varying radii. - **time-series-line**: A line chart widget for displaying data over time. - **time-series-bar**: A stacked bar chart widget for displaying data over time. - **vertical-bar**: A vertical bar chart widget for displaying comparative data across categories. - **horizontal-bar**: A horizontal bar chart widget for displaying comparative data across categories. - `layout` WidgetLayout, required — Layout positioning and sizing of a widget within the dashboard grid. - `cols` integer, required — Number of columns the widget spans - `rows` integer, required — Number of rows the widget spans - `x` integer, required — Horizontal position (column index) in the grid - `y` integer, required — Vertical position (row index) in the grid - `request` WidgetRequest, required — Defines the analytics request associated with a widget. This determines what data the widget displays. The `type` field selects the analytics request type. The structure aligns with the computation request schemas (see computation tag): - **measures**: Returns aggregated values. Same shape as `MeasuresRequest` (timeRange, metrics, filters). - **facets**: Groups data by facet values. Same shape as `FacetsRequest` (timeRange, by, metrics, limit, filters, ranges). - **time-series**: Returns data points over time. Same shape as `TimeSeriesRequest` (timeRange, interval, metrics, by, limit, filters, ranges). - `type` 'measures' | 'facets' | 'time-series', required — The type of analytics request this widget represents (measures, facets, or time series) - `timeRange` TimeRange, required — Time range for analytics queries - `from` string, date-time, required — Start timestamp as an ISO 8601 date string or an epoch unix timestamp - `to` string, date-time, required — End timestamp as an ISO 8601 date string or an epoch unix timestamp - `metrics` MetricRequest[], required — List of metric requests to process. Uses `MetricRequest` which supports metric name, measures, and optional filters. - `name` 'HTTP_REQUESTS' | 'HTTP_ERRORS' | 'HTTP_ERROR_RATE' | 'HTTP_REQUEST_CONTENT_LENGTH' | 'HTTP_RESPONSE_CONTENT_LENGTH' | 'HTTP_ENDPOINT_RESPONSE_TIME' | 'HTTP_GATEWAY_RESPONSE_TIME' | 'HTTP_GATEWAY_LATENCY' | 'LLM_PROMPT_TOKEN_SENT' | 'LLM_PROMPT_TOKEN_RECEIVED' | 'LLM_PROMPT_TOKEN_SENT_COST' | 'LLM_PROMPT_TOKEN_RECEIVED_COST' | 'LLM_PROMPT_TOTAL_TOKEN' | 'LLM_PROMPT_TOKEN_TOTAL_COST' | 'MESSAGE_PAYLOAD_SIZE' | 'MESSAGES' | 'MESSAGE_ERRORS' | 'MESSAGE_GATEWAY_LATENCY' | 'EDGE_DETECTION_COUNT' | 'EDGE_TOKENS_IN' | 'EDGE_TOKENS_OUT' | 'EDGE_HEARTBEAT_COUNT' | 'NATIVE_CONNECTIONS_SUMMARY' | 'NATIVE_MESSAGES_PRODUCED_DOWNSTREAM' | 'NATIVE_MESSAGES_PRODUCED_UPSTREAM' | 'NATIVE_MESSAGES_CONSUMED_DOWNSTREAM' | 'NATIVE_MESSAGES_CONSUMED_UPSTREAM' | 'NATIVE_BYTES_PRODUCED_DOWNSTREAM' | 'NATIVE_BYTES_PRODUCED_UPSTREAM' | 'NATIVE_BYTES_CONSUMED_DOWNSTREAM' | 'NATIVE_BYTES_CONSUMED_UPSTREAM' | 'NATIVE_ACTIVE_CONNECTIONS_DOWNSTREAM' | 'NATIVE_ACTIVE_CONNECTIONS_UPSTREAM' | 'NATIVE_AUTHENTICATIONS_SUCCESS_DOWNSTREAM' | 'NATIVE_AUTHENTICATIONS_SUCCESS_UPSTREAM' | 'NATIVE_AUTHENTICATIONS_FAILURE_DOWNSTREAM' | 'NATIVE_AUTHENTICATIONS_FAILURE_UPSTREAM' | 'NATIVE_OPERATIONS_RECEIVED' | 'NATIVE_OPERATIONS_FORWARDED' | 'NATIVE_OPERATIONS_ANSWERED' | 'NATIVE_OPERATIONS_COMPLETED' | 'NATIVE_OPERATION_GATEWAY_REQUEST_DURATION' | 'NATIVE_OPERATION_BROKER_DURATION' | 'NATIVE_OPERATION_GATEWAY_RESPONSE_DURATION', required — Available metric names for analytics queries - `measures` MeasureName[] — List of measures to compute for this metric - `filters` Filter[] — Request-level filters - union — Filter specification for analytics queries. Filters can be used at the top level of a request to refine the analytics results, or nested within a metrics to refine specific measures. - … - `interval` union — A fixed time interval for time series analytics queries. Intervals are be expressed in milliseconds or duration strings (e.g., 10s, 1m, 5h). - string — Shorthand for expressing interval in seconds, minutes, hours or days as a string - number — Interval in milliseconds - `by` FacetName[] — List of facet names to group by. Required when type is `facets`, optional for `time-series`, not applicable for `measures`. - `limit` integer — Maximum number of buckets to return. Applicable when type is `facets` or `time-series`. - `filters` Filter[] — Top-level filters applied to all metrics in this widget request. - union — Filter specification for analytics queries. Filters can be used at the top level of a request to refine the analytics results, or nested within a metrics to refine specific measures. - StringFilter — Filter specification for string values - … - NumberFilter — Filter specification for numeric values - … - ArrayFilter — Filter specification for array values. - … - `pagination` Pagination — Generic object to handle pagination data. - `page` integer — The current page. - `perPage` integer — The number of items requested per page. - `pageCount` integer — The total number of pages. - `pageItemsCount` integer — The number of items for the current page. - `totalCount` integer — The total number of items, or `-1` if the count could not be computed within the configured timeout. - `links` Links — List of links for pagination - `self` string — Link to current resource - `first` string — In a paginated response, link to the first page - `last` string — In a paginated response, link to the last page - `previous` string — In a paginated response, link to the previous page. Maybe null if current is the first page - `next` string — In a paginated response, link to the next page. Maybe null if current is the last page ## Other responses - `403` — Forbidden - Insufficient permissions to list dashboards. - `500` — Internal server error while listing dashboards. --- [API](https://skmtc.net/gravitee-io/apis/gravitee-io-apim-management-api-analytics.md) · [All operations](https://skmtc.net/gravitee-io/apis/gravitee-io-apim-management-api-analytics/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gravitee-io/gravitee-io-apim-management-api-analytics/revisions/ff8d60356a08/schema)