v47

OpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-011562132.1 KB
dashboards

List custom analytics dashboards

Retrieves a paginated list of all custom analytics dashboards for the current environment.

get/environments/{envId}/analytics/dashboards

Query parameters

pageinteger

Page number (starting from 1)

perPageinteger

Number of items per page

Response

List of dashboards for the current environment.

Example response

{
  "data": [
    {
      "id": "d0152e36-ad24-4f74-a4df-443074d5a796",
      "name": "llm-proxy",
      "createdBy": "e2b573b4-30c8-4c7b-a67b-ad4ab15502d1",
      "createdAt": "2025-10-07T06:50:30Z",
      "lastModified": "2025-10-07T06:50:30Z",
      "labels": {
        "graviteeio/team": "apim"
      },
      "widgets": [
        {
          "id": "1",
          "title": "Requests",
          "type": "stats",
          "layout": {
            "cols": 1,
            "rows": 1,
            "x": 0,
            "y": 0
          },
          "request": {
            "type": "measures",
            "timeRange": {
              "from": "2025-10-07T06:50:30Z",
              "to": "2025-12-07T11:35:30Z"
            },
            "metrics": [
              {
                "name": "HTTP_REQUESTS",
                "measures": [
                  "COUNT"
                ]
              }
            ]
          }
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "perPage": 10,
    "pageCount": 1,
    "pageItemsCount": 1,
    "totalCount": 1
  },
  "links": {
    "self": "/environments/{envId}/analytics/dashboards?page=1&perPage=10"
  }
}