Browse

Generated browse operations.

POST/v1/browseRead a window of a group of titles across the viewer's librariesread

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

Request body application/json · required

Example

{
  "cursor": "eyJvIjoyMH0",
  "homeRowDisplay": "string",
  "limit": 0,
  "pivot": "string",
  "query": null,
  "range": {
    "anchorId": "id_8h2k4q",
    "revision": "r12",
    "start": 0
  },
  "seek": {
    "prefix": "string"
  },
  "selectionBasis": "string",
  "sort": [
    {
      "direction": "string",
      "field": "string",
      "seed": 0
    }
  ]
}

Schema

cursorstringrequired
homeRowDisplaystring
limitintegerrequired
pivotstringrequired
queryanyrequired
rangeobject | any | nullrequired
- anchorIdstring
- revisionstring
- startintegerrequired
seekobject | any | nullrequired
- prefixstringrequired
selectionBasisstringpattern ^[a-f0-9]{64}$
sortarray of objectrequired
- directionstringrequired
- fieldstringrequired
- seedinteger

Responses

200Successapplication/json

Example

{
  "applied": {
    "query": {
      "field": "releaseDate",
      "operator": "within-last-days",
      "value": 1,
      "variant": "relative"
    },
    "seek": {
      "prefix": "string"
    },
    "sort": [
      {
        "direction": "string",
        "field": "string",
        "seed": 0
      }
    ]
  },
  "displayTargets": [
    {
      "entryId": "id_8h2k4q",
      "membershipId": "id_8h2k4q"
    }
  ],
  "entries": [
    {
      "absoluteNumber": 0,
      "activeBeginYear": 0,
      "activeEndYear": 0,
      "addedAt": "2026-10-18T19:30:00Z",
      "airDate": "string",
      "album": {
        "id": "id_8h2k4q",
        "name": "Fargo"
      },
      "albumCount": 0,
      "albumType": "string",
      "artist": {
        "id": "id_8h2k4q",
        "name": "Fargo"
      },
      "artistType": "string",
      "artworkPaths": [
        "string"
      ],
      "audioFacts": {
        "atmos": true,
        "bitDepth": 0,
        "channels": 0,
        "codec": "string",
        "layout": "string",
        "lossless": true,
        "sampleRate": 0
      },
      "author": "string",
      "available": true,
      "backdropUrl": "https://example.com/…",
      "badges": [
        {
          "bitDepth": 17,
          "codec": "string",
          "sampleRate": 1,
          "variant": "lossless"
        }
      ],
      "bookProgress": {
        "bookId": "id_8h2k4q",
        "chapter": {
          "endMs": 1800000,
          "index": 0,
          "startMs": 1800000,
          "title": "Fargo"
        },
        "durationMs": 1800000,
        "itemId": "id_8h2k4q",
        "partPositionMs": 1800000,
        "positionMs": 1800000,
        "remainingMs": 1800000
      },
      "contentRating": "string",
      "count": 0,
      "country": "string",
      "dateBased": true,
      "discNumber": 0,
      "displayTitle": "Fargo",
      "durationMs": 1800000,
      "edition": "string",
      "episodeNumber": 0,
      "favorite": true,
      "genres": [
        "string"
      ],
      "hidden": true,
      "homeActions": {
        "collection": true,
        "delete": true,
        "details": true,
        "download": true,
        "editMetadata": true,
        "favorite": true,
        "myList": true,
        "notInterested": true,
        "play": true,
        "played": true,
        "playlist": true,
        "queue": true,
        "rating": true,
        "refreshMetadata": true,
        "removeFromContinue": true,
        "selection": {
          "collection": true,
          "delete": true,
          "download": true,
          "edit": true,
          "favorite": true,
          "myList": true,
          "play": true,
          "playlist": true,
          "queue": true,
          "refresh": true,
          "watched": true
        },
        "state": {
          "containerRevision": 0,
          "favorite": true,
          "personalRevision": 0,
          "rating": 0,
          "watched": true,
          "watchlisted": true
        },
        "watched": true
      },
      "homeTitleContext": {
        "genres": [
          "string"
        ],
        "kind": "string",
        "seasonCount": 0,
        "year": 0
      },
      "id": "id_8h2k4q",
      "kind": "string",
      "label": "string",
      "language": "en",
      "lastChanged": "string",
      "latestEpisode": {
        "airDate": "string",
        "count": 0,
        "episodeNumber": 0,
        "seasonNumber": 0,
        "title": "Fargo"
      },
      "libraryId": "id_8h2k4q",
      "media": {
        "absoluteNumber": 0,
        "activeBeginYear": 0,
        "activeEndYear": 0,
        "addedAt": "2026-10-18T19:30:00Z",
        "airDate": "string",
        "album": {
          "id": "id_8h2k4q",
          "name": "Fargo"
        },
        "albumCount": 0,
        "albumType": "string",
        "artist": {
          "id": "id_8h2k4q",
          "name": "Fargo"
        },
        "artistType": "string",
        "artworkPaths": [
          "string"
        ],
        "audioFacts": {
          "atmos": true,
          "bitDepth": 0,
          "channels": 0,
          "codec": "string",
          "layout": "string",
          "lossless": true,
          "sampleRate": 0
        },
        "author": "string",
        "available": true,
        "backdropUrl": "https://example.com/…",
        "badges": [
          {}
        ],
        "bookProgress": {
          "bookId": "id_8h2k4q",
          "chapter": {},
          "durationMs": 1800000,
          "itemId": "id_8h2k4q",
          "partPositionMs": 1800000,
          "positionMs": 1800000,
          "remainingMs": 1800000
        },
        "contentRating": "string",
        "count": 0,
        "country": "string",
        "dateBased": true,
        "discNumber": 0,
        "displayTitle": "Fargo",
        "durationMs": 1800000,
        "edition": "string",
        "episodeNumber": 0,
        "favorite": true,
        "genres": [
          "string"
        ],
        "homeActions": {
          "collection": true,
          "delete": true,
          "details": true,
          "download": true,
          "editMetadata": true,
          "favorite": true,
          "myList": true,
          "notInterested": true,
          "play": true,
          "played": true,
          "playlist": true,
          "queue": true,
          "rating": true,
          "refreshMetadata": true,
          "removeFromContinue": true,
          "selection": {},
          "state": {},
          "watched": true
        },
        "homeTitleContext": {
          "genres": [],
          "kind": "string",
          "seasonCount": 0,
          "year": 0
        },
        "id": "id_8h2k4q",
        "kind": "string",
        "label": "string",
        "language": "en",
        "lastChanged": "string",
        "latestEpisode": {
          "airDate": "string",
          "count": 0,
          "episodeNumber": 0,
          "seasonNumber": 0,
          "title": "Fargo"
        },
        "libraryId": "id_8h2k4q",
        "missing": true,
        "narrators": [
          "string"
        ],
        "navigation": {
          "browse": {},
          "category": "string",
          "channelId": "id_8h2k4q",
          "entityId": "id_8h2k4q",
          "provenance": "string",
          "sourceId": "id_8h2k4q",
          "view": "string"
        },
        "new": true,
        "origin": "string",
        "overview": "string",
        "overviewSource": "string",
        "overviewSourceUrl": "https://example.com/…",
        "pageCount": 0,
        "pinned": true,
        "playback": {
          "itemId": "id_8h2k4q",
          "startMs": 1800000
        },
        "plays": 0,
        "posterUrl": "https://example.com/…",
        "progressMs": 1800000,
        "publicationType": "book",
        "publishedYear": 0,
        "publisher": "string",
        "radioSeed": {
          "id": "id_8h2k4q",
          "kind": "string"
        },
        "rating": 0,
        "readingMark": {
          "itemId": "id_8h2k4q",
          "read": true,
          "revision": 0
        },
        "releaseDate": "string",
        "removed": true,
        "resolution": "string",
        "role": "string",
        "seasonCount": 0,
        "seasonNumber": 0,
        "series": [
          {}
        ],
        "show": {
          "id": "id_8h2k4q",
          "name": "Fargo"
        },
        "sortLetter": "string",
        "special": true,
        "stillUrl": "https://example.com/…",
        "subtitle": "Fargo",
        "title": "Fargo",
        "totalAtLeast": 0,
        "trackNumber": 0,
        "unwatchedCount": 0,
        "userRating": 0,
        "watched": true,
        "watchedCount": 0,
        "watchlisted": true,
        "year": 0,
        "yearMax": 0,
        "yearMin": 0
      },
      "missing": true,
      "narrators": [
        "string"
      ],
      "navigation": {
        "browse": {
          "pivot": "string",
          "query": {},
          "sort": []
        },
        "category": "string",
        "channelId": "id_8h2k4q",
        "entityId": "id_8h2k4q",
        "provenance": "string",
        "sourceId": "id_8h2k4q",
        "view": "string"
      },
      "new": true,
      "origin": "string",
      "overview": "string",
      "overviewSource": "string",
      "overviewSourceUrl": "https://example.com/…",
      "pageCount": 0,
      "pinned": true,
      "playback": {
        "itemId": "id_8h2k4q",
        "startMs": 1800000
      },
      "plays": 0,
      "posterUrl": "https://example.com/…",
      "progressMs": 1800000,
      "publicationType": "book",
      "publishedYear": 0,
      "publisher": "string",
      "radioSeed": {
        "id": "id_8h2k4q",
        "kind": "string"
      },
      "rating": 0,
      "readingMark": {
        "itemId": "id_8h2k4q",
        "read": true,
        "revision": 0
      },
      "releaseDate": "string",
      "removed": true,
      "resolution": "string",
      "role": "string",
      "seasonCount": 0,
      "seasonNumber": 0,
      "series": [
        {
          "name": "Fargo",
          "position": "string"
        }
      ],
      "show": {
        "id": "id_8h2k4q",
        "name": "Fargo"
      },
      "sortLetter": "string",
      "special": true,
      "stillUrl": "https://example.com/…",
      "subtitle": "Fargo",
      "title": "Fargo",
      "totalAtLeast": 0,
      "trackNumber": 0,
      "unwatchedCount": 0,
      "userRating": 0,
      "watched": true,
      "watchedCount": 0,
      "watchlisted": true,
      "year": 0,
      "yearMax": 0,
      "yearMin": 0
    }
  ],
  "pageInfo": {
    "durationIsLowerBound": true,
    "durationMs": 1800000,
    "hasMore": true,
    "nextCursor": "eyJvIjoyMH0",
    "revision": "r12",
    "start": 0,
    "total": 0,
    "totalIsLowerBound": true
  },
  "pivot": "string",
  "positionIndex": [
    {
      "index": 0,
      "key": "string"
    }
  ],
  "wholeSelection": {
    "catalogRevision": "r12",
    "selector": {
      "query": {
        "filter": null,
        "libraryId": "id_8h2k4q",
        "pivot": "string",
        "selectionBasis": "string",
        "sort": [
          {}
        ]
      }
    },
    "total": 0,
    "types": [
      {
        "capabilityCounts": {
          "collection": 0,
          "delete": 0,
          "download": 0,
          "edit": 0,
          "favorite": 0,
          "myList": 0,
          "play": 0,
          "playlist": 0,
          "queue": 0,
          "refresh": 0,
          "watched": 0
        },
        "count": 0,
        "kind": "string",
        "libraries": [
          {}
        ]
      }
    ],
    "unavailableActions": {
      "delete": "unsupported-sort",
      "metadataPreview": "preview-limit",
      "play": "unsupported-sort",
      "playlist": "unsupported-sort",
      "queue": "unsupported-sort"
    }
  },
  "wholeSelectionPreparing": {
    "kind": "browse-selection-preparing",
    "queryId": "id_8h2k4q",
    "retryAfterMs": 1800000,
    "state": "preparing",
    "variant": "preparing"
  },
  "wholeSelectionUnavailable": {
    "reason": "search_not_bounded"
  }
}

Schema

appliedobjectrequired
- queryobject | any | nullrequired
  - fieldstringrequiredone of "releaseDate", "dateAdded", "lastPlayedAt"
  - operatorstringrequiredone of "within-last-days"
  - valueintegerrequired1–36500
  - variant"relative"required
- seekobject
  - prefixstringrequired
- sortarray of objectrequired
  - directionstringrequired
  - fieldstringrequired
  - seedinteger
displayTargetsarray of object
- entryIdstringrequired
- membershipIdstringrequired
entriesarray of objectrequired
- absoluteNumberinteger
- activeBeginYearinteger
- activeEndYearinteger
- addedAtstring | any | null
- airDatestring
- albumobject
  - idstringrequired
  - namestringrequired
- albumCountinteger
- albumTypestring
- artistobject
  - idstringrequired
  - namestringrequired
- artistTypestring
- artworkPathsarray of string
- audioFactsobject
  - atmosboolean
  - bitDepthinteger
  - channelsinteger
  - codecstringrequired
  - layoutstring
  - losslessboolean
  - sampleRateinteger
- authorstring
- availableboolean
- backdropUrlstring
- badgesarray of object0–2 items
  - bitDepthintegerrequired≥ 17
  - codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
  - sampleRateintegerrequired≥ 1
  - variant"lossless"required
- bookProgressobject
  - bookIdstringrequired
  - chapterobject
    endMsintegerrequired
    indexintegerrequired
    startMsintegerrequired
    titlestringrequired
  - durationMsinteger
  - itemIdstringrequired
  - partPositionMsintegerrequired
  - positionMsinteger
  - remainingMsinteger
- contentRatingstring
- countinteger
- countrystring
- dateBasedboolean
- discNumberinteger
- displayTitlestring
- durationMsinteger≥ 0
- editionstring
- episodeNumberinteger
- favoriteboolean
- genresarray of string
- hiddenboolean | any | null
- homeActionsobject
  - collectionbooleanrequired
  - deletebooleanrequired
  - detailsbooleanrequired
  - downloadbooleanrequired
  - editMetadatabooleanrequired
  - favoritebooleanrequired
  - myListbooleanrequired
  - notInterestedboolean
  - playbooleanrequired
  - playedbooleanrequired
  - playlistbooleanrequired
  - queuebooleanrequired
  - ratingbooleanrequired
  - refreshMetadatabooleanrequired
  - removeFromContinueboolean
  - selectionobjectrequired
    collectionbooleanrequired
    deletebooleanrequired
    downloadbooleanrequired
    editbooleanrequired
    favoritebooleanrequired
    myListbooleanrequired
    playbooleanrequired
    playlistbooleanrequired
    queuebooleanrequired
    refreshbooleanrequired
    watchedbooleanrequired
  - stateobjectrequired
    containerRevisionintegerrequired
    favoritebooleanrequired
    personalRevisionintegerrequired
    ratingnumber | any | nullrequired
    watchedbooleanrequired
    watchlistedbooleanrequired
  - watchedbooleanrequired
- homeTitleContextobject
  - genresarray of stringrequired
  - kindstringrequired
  - seasonCountinteger
  - yearinteger
- idstringrequired
- kindstringrequired
- labelstring
- languagestring
- lastChangedstring
- latestEpisodeobject
  - airDatestringrequired
  - countintegerrequired
  - episodeNumberintegerrequired
  - seasonNumberinteger
  - titlestring
- libraryIdstring
- mediaobject
  - absoluteNumberinteger
  - activeBeginYearinteger
  - activeEndYearinteger
  - addedAtstring | any | nullrequired
  - airDatestring
  - albumobject
    idstringrequired
    namestringrequired
  - albumCountinteger
  - albumTypestring
  - artistobject
    idstringrequired
    namestringrequired
  - artistTypestring
  - artworkPathsarray of string
  - audioFactsobject
    atmosboolean
    bitDepthinteger
    channelsinteger
    codecstringrequired
    layoutstring
    losslessboolean
    sampleRateinteger
  - authorstring
  - availableboolean
  - backdropUrlstring
  - badgesarray of object0–2 items
    bitDepthintegerrequired≥ 17
    codecstringrequiredpattern ^[A-Za-z0-9_.+-]{1,64}$
    sampleRateintegerrequired≥ 1
    variant"lossless"required
  - bookProgressobject
    bookIdstringrequired
    chapterobject
    endMsintegerrequired
    indexintegerrequired
    startMsintegerrequired
    titlestringrequired
    durationMsinteger
    itemIdstringrequired
    partPositionMsintegerrequired
    positionMsinteger
    remainingMsinteger
  - contentRatingstring
  - countinteger
  - countrystring
  - dateBasedboolean
  - discNumberinteger
  - displayTitlestring
  - durationMsinteger≥ 0
  - editionstring
  - episodeNumberinteger
  - favoriteboolean
  - genresarray of string
  - homeActionsobject
    collectionbooleanrequired
    deletebooleanrequired
    detailsbooleanrequired
    downloadbooleanrequired
    editMetadatabooleanrequired
    favoritebooleanrequired
    myListbooleanrequired
    notInterestedboolean
    playbooleanrequired
    playedbooleanrequired
    playlistbooleanrequired
    queuebooleanrequired
    ratingbooleanrequired
    refreshMetadatabooleanrequired
    removeFromContinueboolean
    selectionobjectrequired
    collectionbooleanrequired
    deletebooleanrequired
    downloadbooleanrequired
    editbooleanrequired
    favoritebooleanrequired
    myListbooleanrequired
    playbooleanrequired
    playlistbooleanrequired
    queuebooleanrequired
    refreshbooleanrequired
    watchedbooleanrequired
    stateobjectrequired
    containerRevisionintegerrequired
    favoritebooleanrequired
    personalRevisionintegerrequired
    ratingnumber | any | nullrequired
    watchedbooleanrequired
    watchlistedbooleanrequired
    watchedbooleanrequired
  - homeTitleContextobject
    genresarray of stringrequired
    kindstringrequired
    seasonCountinteger
    yearinteger
  - idstringrequired
  - kindstringrequired
  - labelstring
  - languagestring
  - lastChangedstring
  - latestEpisodeobject
    airDatestringrequired
    countintegerrequired
    episodeNumberintegerrequired
    seasonNumberinteger
    titlestring
  - libraryIdstring
  - missingbooleanrequired
  - narratorsarray of string
  - navigationobject
    browseobject
    pivotstringrequiredlength 1–256
    queryobject
    sortarray of objectrequired0–1 items
    directionstringrequiredone of "asc", "desc"
    fieldstringrequired
    categorystring
    channelIdstring
    entityIdstring
    provenancestring
    sourceIdstring
    viewstringrequired
  - newboolean
  - originstring
  - overviewstring
  - overviewSourcestring
  - overviewSourceUrlstring
  - pageCountinteger
  - pinnedboolean
  - playbackobject
    itemIdstringrequired
    startMsinteger≥ 0
  - playsinteger
  - posterUrlstring
  - progressMsinteger≥ 0
  - publicationTypestringone of "book", "magazine", "newspaper"
  - publishedYearinteger
  - publisherstring
  - radioSeedobject
    idstringrequired
    kindstringrequired
  - ratingnumber
  - readingMarkobject
    itemIdstringrequired
    readbooleanrequired
    revisionintegerrequired
  - releaseDatestring
  - removedboolean
  - resolutionstring
  - rolestring
  - seasonCountinteger
  - seasonNumberinteger
  - seriesarray of object
    namestringrequired
    positionstring
  - showobject
    idstringrequired
    namestringrequired
  - sortLetterstring
  - specialboolean
  - stillUrlstring
  - subtitlestring
  - titlestringrequired
  - totalAtLeastinteger
  - trackNumberinteger
  - unwatchedCountinteger
  - userRatinginteger | any | null
  - watchedboolean
  - watchedCountinteger
  - watchlistedboolean
  - yearinteger
  - yearMaxinteger
  - yearMininteger
- missingboolean
- narratorsarray of string
- navigationobject
  - browseobject
    pivotstringrequiredlength 1–256
    queryobject
    sortarray of objectrequired0–1 items
    directionstringrequiredone of "asc", "desc"
    fieldstringrequired
  - categorystring
  - channelIdstring
  - entityIdstring
  - provenancestring
  - sourceIdstring
  - viewstringrequired
- newboolean
- originstring
- overviewstring
- overviewSourcestring
- overviewSourceUrlstring
- pageCountinteger
- pinnedboolean
- playbackobject
  - itemIdstringrequired
  - startMsinteger≥ 0
- playsinteger
- posterUrlstring
- progressMsinteger≥ 0
- publicationTypestringone of "book", "magazine", "newspaper"
- publishedYearinteger
- publisherstring
- radioSeedobject
  - idstringrequired
  - kindstringrequired
- ratingnumber
- readingMarkobject
  - itemIdstringrequired
  - readbooleanrequired
  - revisionintegerrequired
- releaseDatestring
- removedboolean
- resolutionstring
- rolestring
- seasonCountinteger
- seasonNumberinteger
- seriesarray of object
  - namestringrequired
  - positionstring
- showobject
  - idstringrequired
  - namestringrequired
- sortLetterstring
- specialboolean
- stillUrlstring
- subtitlestring
- titlestring
- totalAtLeastinteger
- trackNumberinteger
- unwatchedCountinteger
- userRatinginteger | any | null
- watchedboolean
- watchedCountinteger
- watchlistedboolean
- yearinteger
- yearMaxinteger
- yearMininteger
pageInfoobjectrequired
- durationIsLowerBoundbooleanrequired
- durationMsintegerrequired
- hasMorebooleanrequired
- nextCursorstringrequired
- revisionstringrequired
- startintegerrequired
- totalintegerrequired
- totalIsLowerBoundbooleanrequired
pivotstringrequired
positionIndexarray of objectrequired
- indexintegerrequired
- keystringrequired
wholeSelectionobject
- catalogRevisionstringrequired
- selectorobjectrequired
  - queryobjectrequired
    filterany
    libraryIdstringrequired
    pivotstringrequired
    selectionBasisstringpattern ^[a-f0-9]{64}$
    sortarray of object
    directionstringrequired
    fieldstringrequired
    seedinteger
- totalintegerrequired
- typesarray of objectrequired
  - capabilityCountsobjectrequired
    collectionintegerrequired
    deleteintegerrequired
    downloadintegerrequired
    editintegerrequired
    favoriteintegerrequired
    myListintegerrequired
    playintegerrequired
    playlistintegerrequired
    queueintegerrequired
    refreshintegerrequired
    watchedintegerrequired
  - countintegerrequired
  - kindstringrequired
  - librariesarray of objectrequired
    countintegerrequired
    libraryIdstringrequired
- unavailableActionsobject
  - deletestringone of "unsupported-sort"
  - metadataPreviewstringone of "preview-limit"
  - playstringone of "unsupported-sort"
  - playliststringone of "unsupported-sort"
  - queuestringone of "unsupported-sort"
wholeSelectionPreparingobject
- kindstringrequiredone of "browse-selection-preparing"
- queryIdstringrequiredlength 1–128
- retryAfterMsintegerrequired≥ 1
- statestringrequiredone of "preparing"
- variant"preparing"required
wholeSelectionUnavailableobject
- reasonstringrequiredone of "search_not_bounded"

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/browse" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "cursor": "eyJvIjoyMH0",
  "homeRowDisplay": "string",
  "limit": 0,
  "pivot": "string",
  "query": null,
  "range": {
    "anchorId": "id_8h2k4q",
    "revision": "r12",
    "start": 0
  },
  "seek": {
    "prefix": "string"
  },
  "selectionBasis": "string",
  "sort": [
    {
      "direction": "string",
      "field": "string",
      "seed": 0
    }
  ]
}'

POST/v1/browse/countsRead bounded group counts for filter relax suggestionsread

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

Request body application/json · required

Example

{
  "pivot": "string",
  "queries": [
    {
      "id": "id_8h2k4q",
      "query": {
        "field": "releaseDate",
        "operator": "within-last-days",
        "value": 1,
        "variant": "relative"
      }
    }
  ]
}

Schema

pivotstringrequired
queriesarray of objectrequired
- idstringrequired
- queryobject | any | nullrequired
  - fieldstringrequiredone of "releaseDate", "dateAdded", "lastPlayedAt"
  - operatorstringrequiredone of "within-last-days"
  - valueintegerrequired1–36500
  - variant"relative"required

Responses

200Successapplication/json

Example

{
  "counts": [
    {
      "id": "id_8h2k4q",
      "revision": "r12",
      "total": 0,
      "totalIsLowerBound": true
    }
  ]
}

Schema

countsarray of objectrequired
- idstringrequired
- revisionstringrequired
- totalintegerrequired
- totalIsLowerBoundbooleanrequired

defaultRequest refused or unavailableapplication/json

Example

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

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestinvalid_queryunauthorizednot_permittednot_foundstale_continuationinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/browse/counts" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"pivot":"string","queries":[{"id":"id_8h2k4q","query":{"field":"releaseDate","operator":"within-last-days","value":1,"variant":"relative"}}]}'

GET/v1/browse/facetsRead counted facet choices across the viewer's libraries, or within one list's titlesread

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_facets

Parameters

Name	In	Type
`field`	query	`string`
`q`	query	`string`
`limit`	query	`integer`≥ 1
`group`	query	`string`
`value`	query	`string`
`query`	query	`string`
`pivot`	query	`string`

Responses

200Successapplication/json

Example

{
  "field": "string",
  "revision": "r12",
  "total": 0,
  "totalIsLowerBound": true,
  "values": [
    {
      "count": 0,
      "countIsLowerBound": true,
      "label": "string",
      "seriesId": "id_8h2k4q",
      "value": "string"
    }
  ]
}

Schema

fieldstringrequired
revisionstring
totalintegerrequired
totalIsLowerBoundbooleanrequired
valuesarray of objectrequired
- countintegerrequired
- countIsLowerBoundbooleanrequired
- labelstringrequired
- seriesIdstringpattern ^[A-Za-z0-9_-]{43}$
- valuestringrequired

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/facets" \
  -H "Authorization: Bearer $PORTICO_API_KEY"