Skip to main content
GET
/
v1
/
analytics
/
performance
/
engine
Get Engine Performance
curl --request GET \
  --url https://api.mixpeek.com/v1/analytics/performance/engine \
  --header 'Authorization: <authorization>' \
  --header 'X-Namespace: <x-namespace>'
{
  "time_range": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "metrics": [
    {
      "time_bucket": "2023-11-07T05:31:56Z",
      "execution_count": 123,
      "avg_latency_ms": 123,
      "p50_latency_ms": 123,
      "p95_latency_ms": 123,
      "p99_latency_ms": 123,
      "max_latency_ms": 123
    }
  ],
  "summary": {
    "total_executions": 0,
    "avg_latency_ms": 0,
    "p50_latency_ms": 0,
    "p95_latency_ms": 0,
    "p99_latency_ms": 0,
    "max_latency_ms": 0,
    "total_time_seconds": 0
  }
}

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'

Query Parameters

​
hours
integer | null

Hours of history (alternative to date range)

Required range: 1 <= x <= 720
​
start_date
string<date-time> | null

Start date for time range

​
end_date
string<date-time> | null

End date for time range

​
group_by
string
default:hour

Time grouping (minute, hour, day, week)

Response

Successful Response

Response for engine performance query.

​
time_range
TimeRange · object
required

Time range of the query

​
metrics
PerformanceMetric · object[]
required

Time-series performance metrics

​
summary
PerformanceSummary · object

Overall summary statistics