Taxonomy Analytics

Get a taxonomy analytics run

Changed on

Retrieve a single persisted analytics run (its parameters and stored result) so it can be reviewed or re-run.

get/v1/taxonomies/{taxonomy_id}/analytics/runs/{run_id}

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/taxonomies/{taxonomy_id}/analytics/runs/{run_id}
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

taxonomy_idstring required
run_idstring required

Response

Successful Response

run_idstring required

Stable run identifier (taxrun_...)

taxonomy_idstring required

Taxonomy analyzed

collection_idstring required

Collection analyzed

analysis_type'transitions' | 'paths' required

Kind of taxonomy step-analytics computed for a persisted run.

Attributes: TRANSITIONS: Direct A→B transition analytics (conversion rate, durations, predictor lifts) produced by the /analytics/transitions endpoint. PATHS: Multi-step path discovery produced by the /analytics/paths endpoint.

paramsobject

Request params used for the run

params_hashstring required

De-dup hash of the normalized params

from_stepstring required

Starting step

to_stepstring required

Ending step

namestring nullable

Optional run label

resultobject nullable

Computed analytics result

statusstring

Run status

error_messagestring nullable

Error message if the run failed

run_countinteger

Number of times these params have been executed

namespace_idstring

Tenant namespace

internal_idstring

Tenant/org id

created_atstring date-time nullable

First persisted at

updated_atstring date-time nullable

Last (re-)executed at

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API