Skip to content

Metric API

api_delete_metric(met_id)

Deletes a metric identified by its unique metric ID.

Parameters:

Name Type Description Default
met_id str

The unique identifier for the metric to be deleted.

 required

Returns:

Name Type Description
bool bool

True if the metric was successfully deleted, False otherwise.

Raises:

Type Description
Exception

If the deletion process encounters an error.
Source code in moonshot/src/api/api_metrics.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
@validate_call
def api_delete_metric(met_id: str) -> bool:
    """
    Deletes a metric identified by its unique metric ID.

    Args:
        met_id (str): The unique identifier for the metric to be deleted.

    Returns:
        bool: True if the metric was successfully deleted, False otherwise.

    Raises:
        Exception: If the deletion process encounters an error.
    """
    return Metric.delete(met_id)

api_get_all_metric()

Retrieves all available metrics.

This function calls the get_available_items method from the Metric class to retrieve all available metrics. It then returns a list of dictionaries, each containing the details of a metric.

Returns:

Type Description
list[dict]

list[dict]: A list of dictionaries, each representing a metric's details.
Source code in moonshot/src/api/api_metrics.py 
26
27
28
29
30
31
32
33
34
35
36
37
def api_get_all_metric() -> list[dict]:
    """
    Retrieves all available metrics.

    This function calls the get_available_items method from the Metric class to retrieve all available metrics.
    It then returns a list of dictionaries, each containing the details of a metric.

    Returns:
        list[dict]: A list of dictionaries, each representing a metric's details.
    """
    _, metrics_info = Metric.get_available_items()
    return metrics_info

api_get_all_metric_name()

Retrieves all available metric names.

This function calls the get_available_items method from the Metric class to retrieve all available metrics. It then extracts the names of each metric and returns a list of these names.

Returns:

Type Description
list[str]

list[str]: A list of strings, each representing a metric name.
Source code in moonshot/src/api/api_metrics.py 
40
41
42
43
44
45
46
47
48
49
50
51
def api_get_all_metric_name() -> list[str]:
    """
    Retrieves all available metric names.

    This function calls the get_available_items method from the Metric class to retrieve all available metrics.
    It then extracts the names of each metric and returns a list of these names.

    Returns:
        list[str]: A list of strings, each representing a metric name.
    """
    metrics_names, _ = Metric.get_available_items()
    return metrics_names