Skip to main content
GET
Get a taxonomy analytics run

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace
string
header
required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

taxonomy_id
string
required
run_id
string
required

Response

Successful Response

A persisted taxonomy step-analytics run.

Every time a user runs a transitions or paths analysis, the request parameters and the computed result are stored (upserted, de-duplicated by a hash of the normalized params) so the run can be listed, reviewed, and re-run later. Re-running the same parameters updates the existing record and increments run_count rather than creating a duplicate.

Attributes: run_id: Stable identifier for the run (taxrun_<token>). taxonomy_id: Taxonomy the analytics were computed against. collection_id: Collection the analytics were computed against. analysis_type: transitions or paths. params: The request parameters used (exclude_none dump of the request body). Enough to reconstruct and re-run the analysis. params_hash: SHA-256 of the normalized params (plus analysis_type and collection_id) — the upsert de-duplication key. from_step: Convenience copy of the transition's starting step. to_step: Convenience copy of the transition's ending step. name: Optional user-provided label for the run. result: The computed analytics result (model_dump of the response). status: Run status; completed on success. error_message: Populated only when a run failed. run_count: Number of times these exact params have been executed. namespace_id: Tenant namespace (auto-populated by the provider). internal_id: Tenant/org id (auto-populated by the provider). created_at: When the run was first persisted. updated_at: When the run was last (re-)executed.

run_id
string
required

Stable run identifier (taxrun_...)

taxonomy_id
string
required

Taxonomy analyzed

collection_id
string
required

Collection analyzed

analysis_type
enum<string>
required

transitions or paths

Available options:
transitions,
paths
params_hash
string
required

De-dup hash of the normalized params

from_step
string
required

Starting step

to_step
string
required

Ending step

params
Params · object

Request params used for the run

name
string | null

Optional run label

result
Result · object | null

Computed analytics result

status
string
default:completed

Run status

error_message
string | null

Error message if the run failed

run_count
integer
default:1

Number of times these params have been executed

namespace_id
string
default:""

Tenant namespace

internal_id
string
default:""

Tenant/org id

created_at
string<date-time> | null

First persisted at

updated_at
string<date-time> | null

Last (re-)executed at