Skip to main content
POST
/
v1
/
taxonomies
/
{taxonomy_id}
/
analytics
/
paths
Analyze multi-step transition paths
curl --request POST \
  --url https://api.mixpeek.com/v1/taxonomies/{taxonomy_id}/analytics/paths \
  --header 'Content-Type: application/json' \
  --data '
{
  "collection_id": "<string>",
  "taxonomy_id": "<string>",
  "from_step": "<string>",
  "to_step": "<string>",
  "max_path_length": 10,
  "min_support": 5,
  "max_window_days": 123,
  "filters": {}
}
'
{
  "from_step": "<string>",
  "to_step": "<string>",
  "total_sequences": 123,
  "completed_sequences": 123,
  "completion_rate": 0.5,
  "paths": [
    {
      "path": [
        "<string>"
      ],
      "count": 1,
      "percentage": 50,
      "avg_duration_sec": 123
    }
  ]
}

Headers

​
Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

​
X-Namespace
string

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Path Parameters

​
taxonomy_id
string
required

Body

application/json

API request model for multi-step path analysis.

Discovers the most common sequences of intermediate steps documents take when progressing from from_step to to_step.

Unlike the transitions endpoint which only analyzes direct A→B progressions, this endpoint reveals the actual paths taken (e.g., A → X → Y → B).

Example: json { "collection_id": "col_emails", "taxonomy_id": "tax_sales_stages", "from_step": "inquiry", "to_step": "closed_won", "max_path_length": 10, "min_support": 5 }

Response includes: - Most common paths sorted by frequency - Count and percentage for each path - Average duration per path

​
collection_id
string
required

Collection to analyze

​
taxonomy_id
string
required

Taxonomy ID

​
from_step
string
required

Starting step

​
to_step
string
required

Ending step

​
max_path_length
integer
default:10

Maximum number of steps in a path

Required range: 2 <= x <= 20
​
min_support
integer
default:5

Minimum sequences required to include a path

Required range: x >= 1
​
max_window_days
integer | null

Maximum duration for path completion (in days)

​
filters
Filters · object

Optional event filters

Response

Successful Response

API response model for multi-step path analysis.

Contains discovered transition paths with frequency and duration statistics.

Example Response: json { "from_step": "inquiry", "to_step": "closed_won", "total_sequences": 1000, "completed_sequences": 350, "completion_rate": 0.35, "paths": [ { "path": ["inquiry", "followup", "proposal", "closed_won"], "count": 120, "percentage": 34.3, "avg_duration_sec": 604800.0 }, { "path": ["inquiry", "proposal", "closed_won"], "count": 90, "percentage": 25.7, "avg_duration_sec": 432000.0 }, { "path": ["inquiry", "closed_won"], "count": 70, "percentage": 20.0, "avg_duration_sec": 172800.0 } ] }

​
from_step
string
required
​
to_step
string
required
​
total_sequences
integer
required

Total sequences that started at from_step

​
completed_sequences
integer
required

Number of sequences that reached to_step

​
completion_rate
number
required

Percentage that completed the path

Required range: 0 <= x <= 1
​
paths
TransitionPath · object[]
required

List of paths sorted by frequency (most common first)

Maximum array length: 100