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 proxyCEL Scripting in Template BuilderProject ScaffoldingBibliotecă media

Fără interfață

Pornire rapidăSplit Screen JSON Component Builder with LLMComponent Zod Pull

API REST

Prezentare generală API RESTgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetObține blocuri cu cache CELgetGET /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}

Preia documentele publicate pentru o schemă — toate, unul, un lot sau o pagină — ca un tablou JSON transmis în flux.

Preia documentele publicate pentru o schemă — toate, un singur document, un lot după ID-uri sau o pagină — difuzate ca un tablou JSON. Disponibil și la /schemas/{schema_name}. Referințele la imagini sunt rezolvate în URL-uri, iar atunci când language este setat, traducerea corespunzătoare este îmbinată peste conținutul de bază.

Autentificare: Cheie API. O cheie este necesară doar când serverul setează require_schema_api_key = true; altfel, sunt permise lecturi anonime.

Parametri de cale

ParametruTipObligatoriuNote
schema_namestringdaSchema documentului, de ex. post.

Parametri de interogare

ParametruTipObligatoriuNote
websiteIduuidnuSite-ul țintă; revine la antetul Host / configurație.
iduuidnuPreia un singur document. Are prioritate față de ids.
idsstringnuUUID-uri separate prin virgule (lot, max. 200). Are prioritate față de paginare.
languagestringnuÎmbină traducerea pentru această localizare peste conținutul de bază.
limitintegernuDimensiunea paginii, implicit 200, limitată la 200.
offsetintegernuRânduri de omis (se aplică doar cu o limită pozitivă).
api_keystringnuAlternativă la antetul x-api-key.

Când nici id, nici ids nu sunt setate, documentele sunt returnate ordonate după published_at DESC.

Răspuns

Un tablou JSON transmis în flux. Fiecare element este conținutul publicat al documentului expus la nivelul superior, plus cheile injectate _id, _title și _publishedAt:

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

Câmpurile de conținut au prioritate față de cheile injectate în caz de coliziune. Referințele la imagini de forma { alt, _asset: { id } } primesc un url rezolvat, injectat în _asset.

Exemplu

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

Erori

  • 400 — websiteId invalid, id invalid sau ids incorecte (goale, mai multe de 200 sau un UUID invalid)
  • 401 — cheie API invalidă (sau lipsă atunci când este necesară)
  • 500 — eșec la interogare
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›