Skip to main content
GET
/
v1
/
analytics
/
indexes
/
usage
Get Field Usage
curl --request GET \
  --url https://api.mixpeek.com/v1/analytics/indexes/usage
{
  "namespace_id": "<string>",
  "period": "<string>",
  "fields": [
    {
      "field_name": "<string>",
      "query_count": 123,
      "unique_queries": 123,
      "is_indexed": true,
      "is_protected": true,
      "avg_latency_ms": 123,
      "p95_latency_ms": 123,
      "first_seen": "2023-11-07T05:31:56Z",
      "last_seen": "2023-11-07T05:31:56Z"
    }
  ],
  "total_fields": 123,
  "indexed_fields": 123,
  "unindexed_fields": 123
}

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

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

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_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"

Query Parameters

​
period
string
default:24h

Time period: Xh (hours) or Xd (days), e.g., 24h, 7d, 30d

Pattern: ^(\d+h|\d+d)$
​
min_count
integer
default:1

Minimum query count to include a field

Required range: 1 <= x <= 10000

Response

Successful Response

Response containing field usage statistics.

​
namespace_id
string
required

Namespace being analyzed

​
period
string
required

Analysis period (24h, 7d, 30d)

​
fields
FieldUsageStat · object[]
required

Field usage statistics

​
total_fields
integer
required

Total number of fields found

​
indexed_fields
integer
required

Number of indexed fields

​
unindexed_fields
integer
required

Number of unindexed fields