Get Folder Facets

Returns every attribute available on media within a folder, with distinct-item counts. The returned filter_key on each facet can be passed back to Get Folder Contents as part of attributes= to filter the listing. Per-template exclusion: when computing counts for a facet, filters on that same template_key are ignored; filters on other templates still apply. This matches the OR-within-template / AND-across-template filter semantics so users can multi-select within a template and still see realistic counts for the other values.

GET/api/v1/{app_id}/folders/{id}/facets

Authorization

AuthorizationAPI key · headerrequired

Bearer token (format: "Bearer {token}")

Path parameters

app_idstringrequired

App ID

idstringrequired

Folder ID

Query parameters

typestring

Filter by type: image, video, file, all (default: all)

attributesstring[]

Filter by attribute(s). Same syntax as Get Folder Contents: repeat the query parameter once per filter, each in the form template_key/attribute_key. Per-template exclusion applies when computing counts (filters on the same template_key are ignored).

Responses

200

Folder facets

dataFolderFacetResponse[] | null

Show properties

Array of FolderFacetResponse

activeboolean

countinteger

descriptionstring

filter_keystring

keystring

namestring

template_keystring

valuesFolderFacetValueResponse[] | null

Show properties

Array of FolderFacetValueResponse

countinteger

typestring

valuestring

successboolean

400

Invalid request

detailsstring[] | null

errorstring

404

Folder not found

detailsstring[] | null

errorstring

500

Internal server error

detailsstring[] | null

errorstring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

app_idpath*App IDidpath*Folder IDtypequeryFilter by type: image, video, file, all (default: all)attributesqueryFilter by attribute(s). Same syntax as Get Folder Contents: repeat the query parameter once per filter, each in the form template_key/attribute_key. Per-template exclusion applies when computing counts (filters on the same template_key are ignored).

Request

curl -X GET '//dam.enad.io/api/v1/string/folders/string/facets' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Accept: application/json'

const response = await fetch("//dam.enad.io/api/v1/string/folders/string/facets", {
  method: "GET",
  headers: {
    "Authorization": "YOUR_API_KEY",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "//dam.enad.io/api/v1/string/folders/string/facets",
    headers={
        "Authorization": "YOUR_API_KEY",
        "Accept": "application/json"
    },
)

Response

{
  "data": [
    {
      "active": true,
      "count": 0,
      "description": "string",
      "filter_key": "string",
      "key": "string",
      "name": "string",
      "template_key": "string",
      "values": [
        {
          "count": 0,
          "type": "string",
          "value": "string"
        }
      ]
    }
  ],
  "success": true
}

{
  "details": [
    "string"
  ],
  "error": "string"
}

{
  "details": [
    "string"
  ],
  "error": "string"
}

{
  "details": [
    "string"
  ],
  "error": "string"
}