profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchAdminipaneeli puhverserveri seadistamineCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Headless

KiirkäivitusSplit Screen JSON Component Builder with LLMComponent Zod Pull

RESTi API

REST API OverviewgetConnect your websitegetMarsruutide hankiminegetGET /routegetGET /blocksgetGET /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}

Too avaldatud dokumendid skeemi jaoks — kõik, üks dokument, partii või leht — voogedastatud JSON-massiivina.

Too skeemi avaldatud dokumendid — kõik, üksik dokument, ID-de kaupa partii või üks leht — voogedastatuna JSON-massiivina. Saadaval ka aadressil /schemas/{schema_name}. Pildiviited lahendatakse URL-ideks ning kui language on määratud, liidetakse vastav tõlge alus-sisule.

Autentimine: API-võti. Võtit on vaja ainult siis, kui server seab require_schema_api_key = true; vastasel juhul on anonüümsed lugemised lubatud.

Teeparameetrid

ParameeterTüüpNõutavMärkused
schema_namestringjahDokumendi skeem, nt post.

Päringu parameetrid

ParameeterTüüpNõutavMärkused
websiteIduuideiSihtveebisait; vaikimisi kasutatakse päist Host või konfiguratsiooni.
iduuideiToo üks dokument. Ületab ids.
idsstringeiKomaga eraldatud UUID-d (partii, maksimaalselt 200). Ületab leheküljestamise.
languagestringeiLiida selle lokaadi tõlge alus-sisule.
limitintegereiLehe suurus, vaikimisi 200, ülempiir 200.
offsetintegereiJättavate ridade arv (rakendub ainult positiivse piirmäära korral).
api_keystringeiAlternatiiv päisele x-api-key.

Kui ei ole määratud ei id ega ids, tagastatakse dokumendid järjestatuna published_at DESC järgi.

Vastus

Voogedastatud JSON-massiiv. Iga element on dokumendi avaldatud sisu laotatuna ülemisele tasemele ning lisatud võtmed _id, _title ja _publishedAt:

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

Sisuväljad eelistatakse lisatud võtmetele konfliktide korral. Kujul { alt, _asset: { id } } pildiviidetele lisatakse _asset-isse lahendatud url.

Näide

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

Veateated

  • 400 — vigane websiteId, vigane id või sobimatu ids (tühi, üle 200 või vigane UUID)
  • 401 — vigane API-võti (või puudub, kui nõutud)
  • 500 — päringu nurjumine
Continue Reading
Previous‹GET /components/{name}NextGET /content-changes (SSE)›