List metrics by test pattern

List all metrics for which the item member match the given pattern.

GET /api/v1/items/like/:pattern/metrics

Parameters

Attribute	Type	Required	Description
pattern	string	Yes	Pattern to use for filtering metrics.
page	integer	No	Directly jump to the requested page.

Example

$ curl -X GET https://monitor.instance.org/api/v1/items/like/test_server/metrics

Example response:

{
  "metrics":
  [
    {
      "session_h": "0041724ff4e0adac62b70b4f810c79fc5ad8ba5b",
      "context_h": "e9188c68dd9ddeccd0a2f59422d16a2bf7337683",
      "item_start_time": "2020-12-04T23:18:15.661016",
      "item_path": "tests.test_file",
      "item": "test_server_up",
      "item_variant": "test_server_up[]",
      "item_fs_loc": "tests/test_file.py",
      "kind": "function",
      "component": "server",
      "total_time": 0,
      "user_time": 0,
      "kernel_time": 0,
      "cpu_usage": 0,
      "mem_usage": 0
    },
    {
      "session_h": "0041724ff4e0adac62b70b4f810c79fc5ad8ba5b",
      "context_h": "e9188c68dd9ddeccd0a2f59422d16a2bf7337683",
      "item_start_time": "2020-12-04T23:18:15.661016",
      "item_path": "tests.test_file",
      "item": "test_server_ready",
      "item_variant": "test_server_ready[]",
      "item_fs_loc": "tests/test_file.py",
      "kind": "function",
      "component": "server",
      "total_time": 0,
      "user_time": 0,
      "kernel_time": 0,
      "cpu_usage": 0,
      "mem_usage": 0
    }
  ],
  "prev_url": "/api/v1/metrics/?page=1",
  "next_url": "/api/v1/metrics/?page=3",
  "total_page": 3
 }

List metrics by test

List all metrics for a given test, regardless of variants possibilities.

GET /api/v1/items/:item/metrics

Parameters

Attribute	Type	Required	Description
item	string	Yes	Full item name of the requested test.
page	integer	No	Directly jump to the requested page.

Example

$ curl -X GET https://monitor.instance.org/api/v1/items/test_that/metrics

Example response:

{
 "metrics":
 [
   {
     "session_h": "0041724ff4e0adac62b70b4f810c79fc5ad8ba5b",
     "context_h": "e9188c68dd9ddeccd0a2f59422d16a2bf7337683",
     "item_start_time": "2020-12-04T23:18:15.661016",
     "item_path": "tests.test_file",
     "item": "test_that",
     "item_variant": "test_that[x_1]",
     "item_fs_loc": "tests/test_file.py",
     "kind": "function",
     "component": "server",
     "total_time": 0,
     "user_time": 0,
     "kernel_time": 0,
     "cpu_usage": 0,
     "mem_usage": 0
   },
   {
     "session_h": "0041724ff4e0adac62b70b4f810c79fc5ad8ba5b",
     "context_h": "e9188c68dd9ddeccd0a2f59422d16a2bf7337683",
     "item_start_time": "2020-12-04T23:18:15.661016",
     "item_path": "tests.test_file",
     "item": "test_that",
     "item_variant": "test_that[x_3]",
     "item_fs_loc": "tests/test_file.py",
     "kind": "function",
     "component": "server",
     "total_time": 0,
     "user_time": 0,
     "kernel_time": 0,
     "cpu_usage": 0,
     "mem_usage": 0
   }
 ],
 "prev_url": "/api/v1/metrics/?page=1",
 "next_url": "/api/v1/metrics/?page=3",
 "total_page": 3
}

Count all metrics for a given test

Count all metrics entries having the given item name.

GET /api/v1/items/<string:item>/metrics/count

Parameters

Attribute	Type	Required	Description
item	string	Yes	Full item name of the requested test.

Example

$ curl -X GET https://monitor.instance.org/api/v1/items/test_that/metrics/count

Example response:

{
 "count": 312
}