Distinct

Finds the distinct values for a specified field across a single collection and returns the results in an array.

[Distinct] - Finds the distinct values for a specified field across a single collection and returns the results in an array.

get

Finds the distinct values for a specified field across a single collection and returns the results in an array. https://docs.codemash.io/api/database/collections/distinct

Authorizations

Path parameters

CollectionNamestringRequired

Collection name - unique, lowercased, collection name without whitespace. E.g., if your collection title you have entered in the CodeMash dashboard is "Business Trips" then collection name would be "business-trips".

versionstringRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v2

Query parameters

FieldstringRequired

The field for which to return distinct values

Header parameters

AcceptanyRequired

Accept Header

X-CM-ClusterstringOptional

API key of your cluster. Can be passed in a header as X-CM-Cluster.

X-CM-ProjectIdstringRequired

ID of your project. Can be passed in a header as X-CM-ProjectId.

CultureCodestringOptional

Specify culture code when your response from the API should be localised. E.g.: en

Responses

200

Success

application/json

get

HTTPcURLJavaScriptPython

GET //{version}/db/{CollectionName}/distinct HTTP/1.1
Host: api.codemash.io
Authorization: YOUR_API_KEY
X-CM-ProjectId: text
Accept: */*

200

Success

{
  "response_status": {
    "error_code": "text",
    "message": "text",
    "stack_trace": "text",
    "errors": [
      {
        "error_code": "text",
        "field_name": "text",
        "message": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ],
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "result": [
    {}
  ]
}

[Distinct] - Finds the distinct values for a specified field across a single collection and returns the results in an array.

post

Finds the distinct values for a specified field across a single collection and returns the results in an array. https://docs.codemash.io/api/database/collections/distinct

Authorizations

Path parameters

CollectionNamestringRequired

Collection name - unique, lowercased, collection name without whitespace. E.g., if your collection title you have entered in the CodeMash dashboard is "Business Trips" then collection name would be "business-trips".

versionstringRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v2

Header parameters

AcceptanyRequired

Accept Header

X-CM-ClusterstringOptional

API key of your cluster. Can be passed in a header as X-CM-Cluster.

X-CM-ProjectIdstringRequired

ID of your project. Can be passed in a header as X-CM-ProjectId.

CultureCodestringOptional

Specify culture code when your response from the API should be localised. E.g.: en

Body

FieldstringRequired

The field for which to return distinct values

FilterstringOptional

A query that specifies the documents from which to retrieve the distinct values

Responses

200

Success

application/json

post

HTTPcURLJavaScriptPython

POST //{version}/db/{CollectionName}/distinct HTTP/1.1
Host: api.codemash.io
Authorization: YOUR_API_KEY
X-CM-ProjectId: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 32

"Field='text'&Filter='text'"

200

Success

{
  "response_status": {
    "error_code": "text",
    "message": "text",
    "stack_trace": "text",
    "errors": [
      {
        "error_code": "text",
        "field_name": "text",
        "message": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ],
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "result": [
    {}
  ]
}