Steve Fox
03/18/2026, 3:33 PMkapa.ai
03/18/2026, 3:33 PMSteve Fox
03/18/2026, 3:37 PMkapa.ai
03/18/2026, 3:38 PMMauricio Cabezas
03/18/2026, 3:55 PMSteve Fox
03/18/2026, 6:27 PMSteve Fox
03/19/2026, 3:38 PMkapa.ai
03/19/2026, 3:38 PMGET /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}
[Get a Metric]
Example using curl
curl $HOST_URL/api/v1/entities/workspaces/<workspace_id>/metrics/<metric_id> \
-H 'Authorization: Bearer $API_TOKEN'
Example using the Python SDK (gooddata_api_client)
import gooddata_api_client
from gooddata_api_client.api import metrics_api
from pprint import pprint
configuration = gooddata_api_client.Configuration(
host="http://localhost"
)
with gooddata_api_client.ApiClient() as api_client:
api_instance = metrics_api.MetricsApi(api_client)
workspace_id = "workspaceId_example"
object_id = "objectId_example"
try:
api_response = api_instance.get_entity_metrics(workspace_id, object_id)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception: %s\n" % e)
[MetricsApi docs]
What the response includes
The returned metric entity contains:
• id – the metric's unique identifier
• attributes.title – human-readable name
• attributes.content.maql – the MAQL expression defining the metric
• attributes.content.format – the display format (e.g. $#,##0)
• attributes.description, tags, createdAt, modifiedAt, etc.
[OpenAPI schema]
You can also use optional query parameters like include (to pull in related facts, attributes, datasets, etc.) and filter (RSQL-based filtering). 👍 0 button 👎 0 button ℹ️ Tip: Mention @kapa.ai in the thread for follow-ups.
👀 Our Support team monitors all messages and will jump in if needed.Steve Fox
03/19/2026, 3:39 PMkapa.ai
03/19/2026, 3:39 PMSteve Fox
03/19/2026, 4:03 PMkapa.ai
03/19/2026, 4:03 PMSteve Fox
03/19/2026, 4:29 PMkapa.ai
03/19/2026, 4:29 PMSteve Fox
03/19/2026, 4:30 PMkapa.ai
03/19/2026, 4:30 PM