profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxySkriptovanie v nástroji na tvorbu šablónProject ScaffoldingKnižnica médií

Headless

Rýchly štartSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Prehľad REST APIgetConnect your websitegetZískanie trásgetZískanie trasygetZískaj blokygetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /dataset/{schema_name}

Načítajte publikované dokumenty pre schému — všetky, jeden, dávku alebo stránku — ako streamované pole JSON.

Načítajte publikované dokumenty pre schému — všetky, jeden dokument, dávku podľa ID alebo stránku — streamované ako pole JSON. Dostupné aj na /schemas/{schema_name}. Referencie na obrázky sa prevádzajú na adresy URL a keď je nastavený parameter language, zodpovedajúci preklad sa zlúči so základným obsahom.

Autorizácia: Kľúč API. Kľúč je vyžadovaný len vtedy, keď server nastaví require_schema_api_key = true; inak sú povolené anonymné čítania.

Parametre cesty

ParameterTypPovinnéPoznámky
schema_namestringyesSchéma dokumentu, napr. post.

Parametre dotazu

ParameterTypPovinnéPoznámky
websiteIduuidnoCieľová webová stránka; ak nie je zadané, použije sa hlavička / konfigurácia Host.
iduuidnoNačíta jeden dokument. Má prednosť pred ids.
idsstringnoIdentifikátory UUID oddelené čiarkami (dávka, max. 200). Má prednosť pred stránkovaním.
languagestringnoZlúči preklad pre túto lokalitu so základným obsahom.
limitintegernoVeľkosť stránky, predvolene 200, limitovaná na 200.
offsetintegernoRiadky, ktoré sa majú preskočiť (použije sa len pri kladnom limite).
api_keystringnoAlternatíva k hlavičke x-api-key.

Keď nie je nastavené ani id, ani ids, dokumenty sa vracajú zoradené podľa published_at DESC.

Odpoveď

Streamované pole JSON. Každý prvok je publikovaný obsah dokumentu rozložený na najvyššej úrovni plus vložené kľúče _id, _title a _publishedAt:

[
  {
    "_id": "...",
    "_title": "Getting Started",
    "_publishedAt": "2026-06-23T20:36:31Z",
    "title": "Getting Started",
    "description": "...",
    "content": "..."
  }
]

Polia obsahu majú pri kolízii prednosť pred vloženými kľúčmi. Referencie na obrázky v tvare { alt, _asset: { id } } dostanú do _asset vložený vyriešený url.

Príklad

curl '{CMS_API_URL}/dataset/post?websiteId=<uuid>&limit=50' \
  -H 'x-api-key: <key>'

Chyby

  • 400 — neplatné websiteId, neplatné id alebo nesprávne ids (prázdne, viac ako 200 alebo neplatné UUID)
  • 401 — neplatný kľúč API (alebo chýba, keď je vyžadovaný)
  • 500 — zlyhanie dotazu
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›