apyhub
Back
▣ STANDARD DATA

List Website Category API

What it does

Category Facets returns category facet data for a catalog view, with optional filtering by limit, page_lang, and country_code.

Use it when you need to build category navigation, localized browse pages, or region-aware filtering in a marketplace or directory. Send the query parameters you need and get back a JSON object containing the facet response; the schema does not define fixed output fields, so treat the response as a structured object rather than a named payload.

limit controls how many facets to request, up to 200. page_lang lets you target a specific page language, and country_code narrows the result set by country. If you’re rendering category lists for different markets, this endpoint gives you a simple way to keep the browsing experience aligned with language and region.

GET
Category facets
https://api.eu.apyhub.com/dosvak/category-facets

QUICKSTART

GUIDE

Quickstart

Fetch category facets with the default limit, plus a language and country filter.

curl -X GET "https://api.eu.apyhub.com/dosvak/category-facets?limit=30&page_lang=en&country_code=US" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object containing the matching website categories and their counts. The response schema is open-ended, so additional fields may be included depending on the available data.

{
  "country_code": "US",
  "page_lang": "en",
  "total": 100,
  "categories": [
    {
      "val": "/Technology",
      "count": 25
    }
  ],
  "attribution": [
  ]
}
TRY ITLIVE · 100 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Returns category facet data as a JSON object. The endpoint accepts query parameters to control pagination and localization, and the response schema is an object with additional properties allowed.

Query Parameter(s)

AttributeTypeMandatoryDescription
limitIntegerNoMaximum number of items to return.
Default: 30.
Minimum: 1.
Maximum: 200.
page_langStringNoPage language code.
2 to 8 characters.
country_codeStringNoCountry code.
2 to 3 characters.

Response

Returns category facet data, including the selected country and page language, the total number of records, and a list of categories with their associated counts.

FieldTypeMandatoryDescription
country_codeStringNoCountry code used to filter the category facet data.
page_langStringNoPage language used to filter the category facet data.
totalIntegerNoTotal number of records represented by the response.
categoriesArrayNoList of category facets with their associated counts.
categories[].valStringNoCategory path, represented as a hierarchical path.
categories[].countIntegerNoNumber of records associated with the category.
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.