Skip to main content
GET
/
v1
/
analytics
/
collections
/
{collection_id}
/
failures
Get Failure Analysis
curl --request GET \
  --url https://api.mixpeek.com/v1/analytics/collections/{collection_id}/failures
{
  "collection_id": "<string>",
  "time_range": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "error_distribution": [
    {
      "error_type": "<string>",
      "count": 123,
      "percentage": 123,
      "recent_message": "<string>"
    }
  ],
  "total_errors": 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

​
collection_id
string
required

Query Parameters

​
hours
integer
default:72
Required range: 1 <= x <= 720

Response

Successful Response

Failure analysis response.

​
collection_id
string
required
​
time_range
TimeRange · object
required

Time range for analytics queries.

​
error_distribution
ErrorMetrics · object[]
required
​
total_errors
integer
required