Browse Capabilities

Generated browse capabilities operations.

GET/v1/browse-capabilitiesRead the vocabulary of lists across librariesread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_browse_capabilities

Parameters

Name	In	Type	Description
`pivot`	query	`string`

Responses

200Successapplication/json

Example

{
  "fields": [
    {
      "allowedValues": [
        "string"
      ],
      "applicableKinds": [
        "string"
      ],
      "complexity": "string",
      "controlHint": "string",
      "cost": "string",
      "facetSource": {
        "endpoint": "string",
        "field": "string"
      },
      "id": "id_8h2k4q",
      "labelKey": "string",
      "operators": [
        "string"
      ],
      "type": "string"
    }
  ],
  "library": {
    "defaultView": "string",
    "id": "id_8h2k4q",
    "kind": "string",
    "name": "Fargo",
    "pinned": true,
    "summary": {
      "counts": [
        {
          "atLeast": true,
          "count": 0,
          "kind": "string"
        }
      ],
      "coverUrls": [
        "https://example.com/…"
      ],
      "empty": true,
      "emptyKnown": true,
      "firstScan": true,
      "latestArtwork": "string",
      "publicationCounts": [
        {
          "atLeast": true,
          "count": 0,
          "kind": "string"
        }
      ]
    }
  },
  "pivots": [
    {
      "aggregate": "string",
      "browsable": true,
      "defaultSort": [
        {
          "direction": "string",
          "field": "string",
          "seed": 0
        }
      ],
      "entityKinds": [
        "string"
      ],
      "facetSource": {
        "endpoint": "string",
        "field": "string"
      },
      "filters": [
        "string"
      ],
      "id": "id_8h2k4q",
      "labelKey": "string",
      "members": true,
      "paging": "string",
      "sorts": [
        "string"
      ],
      "supportedViews": [
        "string"
      ]
    }
  ],
  "queryLimits": {
    "cursorTtlMs": 1800000,
    "defaultLimit": 0,
    "maximumBytes": 0,
    "maximumClauses": 0,
    "maximumDepth": 0,
    "maximumLimit": 0,
    "maximumSorts": 0
  },
  "quickFilters": [
    {
      "id": "id_8h2k4q",
      "labelKey": "string",
      "query": {
        "field": "releaseDate",
        "operator": "within-last-days",
        "value": 1,
        "variant": "relative"
      }
    }
  ],
  "resolvedPivot": {
    "aggregate": "string",
    "browsable": true,
    "defaultSort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ],
    "entityKinds": [
      "string"
    ],
    "facetSource": {
      "endpoint": "string",
      "field": "string"
    },
    "filters": [
      "string"
    ],
    "id": "id_8h2k4q",
    "labelKey": "string",
    "members": true,
    "paging": "string",
    "sorts": [
      "string"
    ],
    "supportedViews": [
      "string"
    ]
  },
  "sorts": [
    {
      "applicableKinds": [
        "string"
      ],
      "defaultDirection": "string",
      "directions": [
        "string"
      ],
      "expensive": true,
      "id": "id_8h2k4q",
      "labelKey": "string",
      "ownerOnly": true,
      "requiresGroup": true,
      "seeded": true
    }
  ],
  "surfaces": [
    {
      "endpoint": "string",
      "filters": [
        "string"
      ],
      "id": "id_8h2k4q",
      "membershipField": "string",
      "paging": "string",
      "sorts": [
        "string"
      ]
    }
  ]
}

Schema

fieldsarray of objectrequired
- allowedValuesarray of string
- applicableKindsarray of stringrequired
- complexitystringrequired
- controlHintstringrequired
- coststringrequired
- facetSourceobject
  - endpointstringrequired
  - fieldstringrequired
- idstringrequired
- labelKeystringrequired
- operatorsarray of stringrequired
- typestringrequired
libraryobjectrequired
- defaultViewstringrequired
- idstringrequired
- kindstringrequired
- namestringrequired
- pinnedbooleanrequired
- summaryobject
  - countsarray of objectrequired
    atLeastbooleanrequired
    countintegerrequired
    kindstringrequired
  - coverUrlsarray of stringrequired
  - emptybooleanrequired
  - emptyKnownbooleanrequired
  - firstScanbooleanrequired
  - latestArtworkstringrequired
  - publicationCountsarray of object
    atLeastbooleanrequired
    countintegerrequired
    kindstringrequired
pivotsarray of objectrequired
- aggregatestring
- browsablebooleanrequired
- defaultSortarray of objectrequired
  - directionstringrequired
  - fieldstringrequired
  - seedinteger
- entityKindsarray of stringrequired
- facetSourceobject
  - endpointstringrequired
  - fieldstringrequired
- filtersarray of stringrequired
- idstringrequired
- labelKeystringrequired
- membersboolean
- pagingstringrequired
- sortsarray of stringrequired
- supportedViewsarray of stringrequired
queryLimitsobjectrequired
- cursorTtlMsintegerrequired
- defaultLimitintegerrequired
- maximumBytesintegerrequired
- maximumClausesintegerrequired
- maximumDepthintegerrequired
- maximumLimitintegerrequired
- maximumSortsintegerrequired
quickFiltersarray of objectrequired
- idstringrequired
- labelKeystringrequired
- queryobject | any | nullrequired
  - fieldstringrequiredone of "releaseDate", "dateAdded", "lastPlayedAt"
  - operatorstringrequiredone of "within-last-days"
  - valueintegerrequired1–36500
  - variant"relative"required
resolvedPivotobject
- aggregatestring
- browsablebooleanrequired
- defaultSortarray of objectrequired
  - directionstringrequired
  - fieldstringrequired
  - seedinteger
- entityKindsarray of stringrequired
- facetSourceobject
  - endpointstringrequired
  - fieldstringrequired
- filtersarray of stringrequired
- idstringrequired
- labelKeystringrequired
- membersboolean
- pagingstringrequired
- sortsarray of stringrequired
- supportedViewsarray of stringrequired
sortsarray of objectrequired
- applicableKindsarray of stringrequired
- defaultDirectionstringrequired
- directionsarray of stringrequired
- expensivebooleanrequired
- idstringrequired
- labelKeystringrequired
- ownerOnlybooleanrequired
- requiresGroupbooleanrequired
- seededbooleanrequired
surfacesarray of objectrequired
- endpointstringrequired
- filtersarray of stringrequired
- idstringrequired
- membershipFieldstring
- pagingstringrequired
- sortsarray of stringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/browse-capabilities" \
  -H "Authorization: Bearer $PORTICO_API_KEY"