Skip to main content
GET
/
v1
/
analytics
/
retrievers
/
{retriever_id}
/
performance
Get Retriever Performance
curl --request GET \
  --url https://api.mixpeek.com/v1/analytics/retrievers/{retriever_id}/performance \
  --header 'Authorization: <authorization>' \
  --header 'X-Namespace: <x-namespace>'
{
  "retriever_id": "<string>",
  "time_range": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "metrics": [
    {}
  ],
  "summary": {}
}

Headers

Authorization
string
required

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

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

retriever_id
string
required

Query Parameters

start_date
string<date-time> | null

Start date (UTC)

end_date
string<date-time> | null

End date (UTC)

group_by
string
default:hour

Time grouping: hour, day, week

Response

Successful Response

Retriever performance metrics response.

retriever_id
string
required

Retriever identifier

time_range
TimeRange · object
required

Time range of the data

metrics
Metrics · object[]
required

Time-series performance metrics

summary
Summary · object

Aggregated summary statistics