Skip to main content
POST
/
v1
/
collections
/
{collection_identifier}
/
documents
/
distinct
Return distinct values for a single field.
curl --request POST \
  --url https://api.mixpeek.com/v1/collections/{collection_identifier}/documents/distinct \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "field": "<string>",
  "filters": {},
  "limit": 5000
}
'
import requests

url = "https://api.mixpeek.com/v1/collections/{collection_identifier}/documents/distinct"

payload = {
"field": "<string>",
"filters": {},
"limit": 5000
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({field: '<string>', filters: {}, limit: 5000})
};

fetch('https://api.mixpeek.com/v1/collections/{collection_identifier}/documents/distinct', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/collections/{collection_identifier}/documents/distinct",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'field' => '<string>',
'filters' => [

],
'limit' => 5000
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.mixpeek.com/v1/collections/{collection_identifier}/documents/distinct"

payload := strings.NewReader("{\n \"field\": \"<string>\",\n \"filters\": {},\n \"limit\": 5000\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/collections/{collection_identifier}/documents/distinct")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"field\": \"<string>\",\n \"filters\": {},\n \"limit\": 5000\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/collections/{collection_identifier}/documents/distinct")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"field\": \"<string>\",\n \"filters\": {},\n \"limit\": 5000\n}"

response = http.request(request)
puts response.read_body
{
  "field": "<string>",
  "values": [
    {
      "value": "<unknown>",
      "count": 123
    }
  ],
  "total_distinct": 123
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

collection_identifier
string
required

The unique identifier of the collection.

Body

application/json

Field + optional filters/limit for the distinct query.

field
string
required

Document field whose distinct values should be returned. Dotted paths are supported (e.g. metadata.brand_slug). Null/missing values are excluded.

Examples:

"brand_slug"

"metadata.category"

filters
Filters · object | null

Optional pre-aggregation filters, same syntax as the standard aggregation endpoint. Applied before distinct values are computed.

limit
integer | null

Maximum number of distinct values to return (sorted by count desc). Defaults to no limit on the server side; for high-cardinality fields always set a limit to keep the response bounded.

Required range: 1 <= x <= 10000

Response

Successful Response

Flat list of distinct values for a single field.

field
string
required

The field that was queried.

values
DistinctValue · object[]
required

Distinct values sorted by descending count. Respects the limit argument; use the length of this list as the returned count.

total_distinct
integer
required

Number of distinct values in the response (== len(values)). When limit is set this can be less than the true cardinality.