For the complete documentation index, see llms.txt. This page is also available as Markdown.

Metric Store

Setup Metric Store

post

Trigger the fixed Metric Store setup job through the platform control plane.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Responses
202

Successful Response

application/json
run_idintegerRequired
post/v1/metric-store/setup
POST /v1/metric-store/setup HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
202

Successful Response

{
  "run_id": 1
}

Refresh Metric Store

post

Trigger an on-demand canonical Metric Store refresh.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Responses
202

Successful Response

application/json
run_idintegerRequired
post/v1/metric-store/refresh
POST /v1/metric-store/refresh HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
202

Successful Response

{
  "run_id": 1
}

Get Metric Store Run

get

Read the Databricks status for a Metric Store setup or refresh run.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
run_idintegerRequired
Responses
200

Successful Response

application/json
run_idintegerRequired
life_cycle_statestring · nullableOptional
result_statestring · nullableOptional
state_messagestring · nullableOptional
get/v1/metric-store/runs/{run_id}
GET /v1/metric-store/runs/{run_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "run_id": 1,
  "life_cycle_state": "text",
  "result_state": "text",
  "state_message": "text"
}
Deprecated

Setup Metric Store Legacy

post

Deprecated workspace-shaped alias for the environment-level setup route.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Responses
202

Successful Response

application/json
run_idintegerRequired
post/v1/{workspace_id}/metric-store/setup
POST /v1/{workspace_id}/metric-store/setup HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "run_id": 1
}
Deprecated

Refresh Metric Store Legacy

post

Deprecated workspace-shaped alias for the environment-level refresh route.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Responses
202

Successful Response

application/json
run_idintegerRequired
post/v1/{workspace_id}/metric-store/refresh
POST /v1/{workspace_id}/metric-store/refresh HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "run_id": 1
}
Deprecated

Get Metric Store Run Legacy

get

Deprecated workspace-shaped alias for the environment-level run route.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
run_idintegerRequired
Responses
200

Successful Response

application/json
run_idintegerRequired
life_cycle_statestring · nullableOptional
result_statestring · nullableOptional
state_messagestring · nullableOptional
get/v1/{workspace_id}/metric-store/runs/{run_id}
GET /v1/{workspace_id}/metric-store/runs/{run_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "run_id": 1,
  "life_cycle_state": "text",
  "result_state": "text",
  "state_message": "text"
}

Last updated

Was this helpful?