Skip to main content
GET
/
v1
/
analytics
/
collections
/
{collection_id}
/
latency
Get Latency Metrics
curl --request GET \
  --url https://api.mixpeek.com/v1/analytics/collections/{collection_id}/latency
{
  "collection_id": "<string>",
  "time_range": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "metrics": [
    {
      "time_bucket": "2023-11-07T05:31:56Z",
      "document_count": 123,
      "avg_latency_ms": 123,
      "p95_latency_ms": 123,
      "p99_latency_ms": 123
    }
  ],
  "slowest_documents": [
    {}
  ]
}

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

​
collection_id
string
required

Query Parameters

​
hours
integer
default:24
Required range: 1 <= x <= 720
​
group_by
string
default:hour

Response

Successful Response

Processing latency distribution.

​
collection_id
string
required
​
time_range
TimeRange · object
required

Time range for analytics queries.

​
metrics
LatencyMetric · object[]
required
​
slowest_documents
Slowest Documents · object[]