Skip to main content
POST
/
v1
/
analytics
/
retrievers
/
{retriever_id}
/
analyze-tuning
Analyze For Tuning
curl --request POST \
  --url https://api.mixpeek.com/v1/analytics/retrievers/{retriever_id}/analyze-tuning
{
  "retriever_id": "<string>",
  "analysis_period": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "recommendations": [
    {
      "recommendation_type": "<string>",
      "recommended_value": "<unknown>",
      "expected_impact": "<string>",
      "confidence": 0.5,
      "reasoning": "<string>",
      "current_value": "<unknown>"
    }
  ],
  "current_performance": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string

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

Example:

"Bearer YOUR_MIXPEEK_API_KEY"

​
authorization
string
​
X-Namespace
string

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'. Falls back to ?namespace= query parameter if the header is omitted.

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

​
retriever_id
string
required

Query Parameters

​
days
integer
default:7

Days of history to analyze

Required range: 1 <= x <= 90

Response

Successful Response

Response for interaction tuning analysis.

​
retriever_id
string
required

Retriever identifier

​
analysis_period
TimeRange · object
required

Analysis period

​
recommendations
InteractionTuningRecommendation · object[]
required

Tuning recommendations

​
current_performance
Current Performance · object
required

Current performance baseline