Metric Store
Trigger Metric Store setup, refresh, and poll run status through the Platform API.
The Metric Store endpoints let workspace administrators trigger schema setup, on-demand data refresh, and poll the status of those operations.
All endpoints are scoped to a workspace and require an authenticated API key with the appropriate role.
Base Path
/v1/{workspace_id}/metric-storeEndpoints
Trigger Setup
POST /v1/{workspace_id}/metric-store/setupTriggers the one-time Metric Store schema and registry initialization. This operation is idempotent.
Required permission: workspace.update
Rate limit: Write rate limit applies.
Response: 202 Accepted
run_id
integer
Identifier for the triggered run. Use this to poll status.
Error responses:
503 Service Unavailable
The setup job is not configured for this environment.
502 Bad Gateway
The request to trigger the job failed or returned no run identifier.
Trigger Refresh
Triggers an on-demand refresh of the canonical Metric Store models.
Required permission: workspace.update
Rate limit: Write rate limit applies.
Response: 202 Accepted
run_id
integer
Identifier for the triggered run. Use this to poll status.
Error responses:
503 Service Unavailable
The refresh job is not configured for this environment.
502 Bad Gateway
The request to trigger the job failed or returned no run identifier.
Get Run Status
Returns the current status of a Metric Store setup or refresh run.
Required permission: workspace.view
Response: 200 OK
run_id
integer
The run identifier.
life_cycle_state
string or null
Current lifecycle state of the run (e.g., PENDING, RUNNING, TERMINATED).
result_state
string or null
Final result state when the run has completed (e.g., SUCCESS, FAILED). Null while the run is in progress.
state_message
string or null
Human-readable message describing the current state.
Error responses:
404 Not Found
The run identifier does not belong to a Metric Store job.
502 Bad Gateway
The status check failed.
Last updated
Was this helpful?