Skip to content

HubSpot: Site search schemas

4 HubSpot schemas with complete fields and constraints.

← Site search operations · All schemas

Get indexed properties — response body

FieldTypePresenceDescription and constraints
$objectRoot
fieldsobjectRequired within parentThe indexed fields in HubSpot.
Additional keys: see wildcard field
fields.*ModelAdditional keysExpand Get indexed properties — response body — fields value
idstringRequired within parentThe ID of the document in HubSpot.
typestringRequired within parentThe type of document. Can be `SITE_PAGE`, `LANDING_PAGE`, `BLOG_POST`, `LISTING_PAGE`, or `KNOWLEDGE_ARTICLE`.
Known values: BLOG_POST, KNOWLEDGE_ARTICLE, LANDING_PAGE, LISTING_PAGE, SITE_PAGE, STRUCTURED_CONTENT

Referenced models: Get indexed properties — response body — fields value

Get indexed properties — response body — fields value

FieldTypePresenceDescription and constraints
$objectRoot
metadataFieldbooleanRequired within parentIndicates whether the field is a metadata field.
namestringRequired within parentThe name of the indexed field.
valueobjectRequired within parentThe primary value of the indexed field.
valuesarrayRequired within parentAn array of objects representing multiple values for the indexed field.
values[]objectEach item

Search your site — response body

FieldTypePresenceDescription and constraints
$objectRoot
limitJSONRequired within parent
limit (anyOf 1)integerAlternativeThe number of results returned in a single response.
Format: int32
limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
offsetJSONRequired within parent
offset (anyOf 1)integerAlternativeThe starting point for the next set of results in pagination.
Format: int32
offset (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageJSONRequired within parent
page (anyOf 1)integerAlternativeThe current page number in the paginated results.
Format: int32
page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
resultsarrayRequired within parentAn array of search results, each represented by a ContentSearchResult object.
results[]ModelEach itemExpand Search your site — response body — results item
searchTermstringOptionalThe term used in the search query.
totalJSONRequired within parent
total (anyOf 1)integerAlternativeThe total number of results found for the search term.
Format: int64
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Search your site — response body — results item

Search your site — response body — results item

FieldTypePresenceDescription and constraints
$objectRoot
authorFullNamestringOptionalName of the author.
categorystringOptionalThe error category
combinedIdstringOptionalThe ID of the document in HubSpot.
contentTypestringOptionalThe content type, which provides additional information about the nature of the content.
descriptionstringOptionalThe result's description. The content will be determined by the value of `length` in the request.
domainstringRequired within parentThe domain the document is hosted on.
featuredImageUrlstringOptionalURL of the featured image.
idJSONRequired within parent
id (anyOf 1)integerAlternativeThe ID of the content.
Format: int64
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
inBetabooleanOptionalA boolean indicating whether the content is in beta.
isPrivatebooleanOptionalA boolean indicating whether the content is private.
languagestringOptionalThe document's language.
Known values: aa, ab, ae, af, af-na, af-za, agq, agq-cm, ak, ak-gh, am, am-et, an, ann, ann-ng, ar, ar-001, ar-ae, ar-bh, ar-dj, ar-dz, ar-eg, ar-eh, ar-er, ar-il, ar-iq, ar-jo, ar-km, ar-kw, ar-lb, ar-ly, ar-ma, ar-mr, ar-om, ar-ps, ar-qa, ar-sa, ar-sd, ar-so, ar-ss, ar-sy, ar-td, ar-tn, ar-ye, as, as-in, asa, asa-tz, ast, ast-es, av, ay, az, az-az, ba, bal, bal-pk, bas, bas-cm, be, be-by, bem, bem-zm, bez, bez-tz, bg, bg-bg, bgc, bgc-in, bho, bho-in, bi, blo, blo-bj, bm, bm-ml, bn, bn-bd, bn-in, bo, bo-cn, bo-in, br, br-fr, brx, brx-in, bs, bs-ba, ca, ca-ad, ca-es, ca-fr, ca-it, ccp, ccp-bd, ccp-in, ce, ce-ru, ceb, ceb-ph, cgg, cgg-ug, ch, chr, chr-us, ckb, ckb-iq, ckb-ir, co, cr, cs, cs-cz, csw, csw-ca, cu, cu-ru, cv, cv-ru, cy, cy-gb, da, da-dk, da-gl, dav, dav-ke, de, de-at, de-be, de-ch, de-de, de-gr, de-it, de-li, de-lu, dje, dje-ne, doi, doi-in, dsb, dsb-de, dua, dua-cm, dv, dyo, dyo-sn, dz, dz-bt, ebu, ebu-ke, ee, ee-gh, ee-tg, el, el-cy, el-gr, en, en-001, en-150, en-ae, en-ag, en-ai, en-as, en-at, en-au, en-bb, en-be, en-bi, en-bm, en-bs, en-bw, en-bz, en-ca, en-cc, en-ch, en-ck, en-cm, en-cn, en-cx, en-cy, en-cz, en-de, en-dg, en-dk, en-dm, en-ee, en-eg, en-er, en-es, en-fi, en-fj, en-fk, en-fm, en-fr, en-gb, en-gd, en-gg, en-gh, en-gi, en-gm, en-gs, en-gu, en-gy, en-hk, en-hu, en-id, en-ie, en-il, en-im, en-in, en-io, en-it, en-je, en-jm, en-ke, en-ki, en-kn, en-ky, en-lc, en-lr, en-ls, en-lu, en-mg, en-mh, en-mo, en-mp, en-ms, en-mt, en-mu, en-mv, en-mw, en-mx, en-my, en-na, en-nf, en-ng, en-nl, en-no, en-nr, en-nu, en-nz, en-pg, en-ph, en-pk, en-pl, en-pn, en-pr, en-pt, en-pw, en-ro, en-rw, en-sb, en-sc, en-sd, en-se, en-sg, en-sh, en-si, en-sk, en-sl, en-ss, en-sx, en-sz, en-tc, en-th, en-tk, en-tn, en-to, en-tt, en-tv, en-tz, en-ug, en-um, en-us, en-vc, en-vg, en-vi, en-vn, en-vu, en-ws, en-za, en-zm, en-zw, eo, eo-001, es, es-419, es-ar, es-bo, es-br, es-bz, es-cl, es-co, es-cr, es-cu, es-do, es-ea, es-ec, es-es, es-gq, es-gt, es-hn, es-ic, es-mx, es-ni, es-pa, es-pe, es-ph, es-pr, es-py, es-sv, es-us, es-uy, es-ve, et, et-ee, eu, eu-es, ewo, ewo-cm, fa, fa-af, fa-ir, ff, ff-bf, ff-cm, ff-gh, ff-gm, ff-gn, ff-gw, ff-lr, ff-mr, ff-ne, ff-ng, ff-sl, ff-sn, fi, fi-fi, fil, fil-ph, fj, fo, fo-dk, fo-fo, fr, fr-be, fr-bf, fr-bi, fr-bj, fr-bl, fr-ca, fr-cd, fr-cf, fr-cg, fr-ch, fr-ci, fr-cm, fr-dj, fr-dz, fr-fr, fr-ga, fr-gf, fr-gn, fr-gp, fr-gq, fr-ht, fr-km, fr-lu, fr-ma, fr-mc, fr-mf, fr-mg, fr-ml, fr-mq, fr-mr, fr-mu, fr-nc, fr-ne, fr-pf, fr-pm, fr-re, fr-rw, fr-sc, fr-sn, fr-sy, fr-td, fr-tg, fr-tn, fr-vu, fr-wf, fr-yt, frr, frr-de, fur, fur-it, fy, fy-nl, ga, ga-gb, ga-ie, gaa, gaa-gh, gd, gd-gb, gl, gl-es, gn, gsw, gsw-ch, gsw-fr, gsw-li, gu, gu-in, guz, guz-ke, gv, gv-im, ha, ha-gh, ha-ne, ha-ng, haw, haw-us, he, he-il, hi, hi-in, hmn, ho, hr, hr-ba, hr-hr, hsb, hsb-de, ht, ht-ht, hu, hu-hu, hy, hy-am, hz, ia, ia-001, id, id-id, ie, ie-ee, ig, ig-ng, ii, ii-cn, ik, io, is, is-is, it, it-ch, it-it, it-sm, it-va, iu, ja, ja-jp, jgo, jgo-cm, jmc, jmc-tz, jv, jv-id, ka, ka-ge, kab, kab-dz, kam, kam-ke, kar, kde, kde-tz, kea, kea-cv, kg, kgp, kgp-br, kh, khq, khq-ml, ki, ki-ke, kj, kk, kk-kz, kkj, kkj-cm, kl, kl-gl, kln, kln-ke, km, km-kh, kn, kn-in, ko, ko-cn, ko-kp, ko-kr, kok, kok-in, kr, ks, ks-in, ksb, ksb-tz, ksf, ksf-cm, ksh, ksh-de, ku, ku-tr, kv, kw, kw-gb, kxv, kxv-in, ky, ky-kg, la, lag, lag-tz, lb, lb-lu, lg, lg-ug, li, lij, lij-it, lkt, lkt-us, lmo, lmo-it, ln, ln-ao, ln-cd, ln-cf, ln-cg, lo, lo-la, lrc, lrc-iq, lrc-ir, lt, lt-lt, lu, lu-cd, luo, luo-ke, luy, luy-ke, lv, lv-lv, mai, mai-in, mas, mas-ke, mas-tz, mdf, mdf-ru, mer, mer-ke, mfe, mfe-mu, mg, mg-mg, mgh, mgh-mz, mgo, mgo-cm, mh, mi, mi-nz, mk, mk-mk, ml, ml-in, mn, mn-mn, mni, mni-in, mr, mr-in, ms, ms-bn, ms-id, ms-my, ms-sg, mt, mt-mt, mua, mua-cm, my, my-mm, mzn, mzn-ir, na, naq, naq-na, nb, nb-no, nb-sj, nd, nd-zw, nds, nds-de, nds-nl, ne, ne-in, ne-np, ng, nl, nl-aw, nl-be, nl-bq, nl-ch, nl-cw, nl-lu, nl-nl, nl-sr, nl-sx, nmg, nmg-cm, nn, nn-no, nnh, nnh-cm, no, no-no, nqo, nqo-gn, nr, nso, nso-za, nus, nus-ss, nv, ny, nyn, nyn-ug, oc, oc-es, oc-fr, oj, om, om-et, om-ke, or, or-in, os, os-ge, os-ru, pa, pa-in, pa-pk, pcm, pcm-ng, pi, pis, pis-sb, pl, pl-pl, prg, prg-001, ps, ps-af, ps-pk, pt, pt-ao, pt-br, pt-ch, pt-cv, pt-gq, pt-gw, pt-lu, pt-mo, pt-mz, pt-pt, pt-st, pt-tl, qu, qu-bo, qu-ec, qu-pe, raj, raj-in, rm, rm-ch, rn, rn-bi, ro, ro-md, ro-ro, rof, rof-tz, ru, ru-by, ru-kg, ru-kz, ru-md, ru-ru, ru-ua, rw, rw-rw, rwk, rwk-tz, sa, sa-in, sah, sah-ru, saq, saq-ke, sat, sat-in, sbp, sbp-tz, sc, sc-it, sd, sd-in, sd-pk, se, se-fi, se-no, se-se, seh, seh-mz, ses, ses-ml, sg, sg-cf, shi, shi-ma, si, si-lk, sk, sk-sk, sl, sl-si, sm, smn, smn-fi, sms, sms-fi, sn, sn-zw, so, so-dj, so-et, so-ke, so-so, sq, sq-al, sq-mk, sq-xk, sr, sr-ba, sr-cs, sr-me, sr-rs, sr-xk, ss, st, st-ls, st-za, su, su-id, sv, sv-ax, sv-fi, sv-se, sw, sw-cd, sw-ke, sw-tz, sw-ug, sy, syr, syr-iq, syr-sy, szl, szl-pl, ta, ta-in, ta-lk, ta-my, ta-sg, te, te-in, teo, teo-ke, teo-ug, tg, tg-tj, th, th-th, ti, ti-er, ti-et, tk, tk-tm, tl, tn, tn-bw, tn-za, to, to-to, tok, tok-001, tr, tr-cy, tr-tr, ts, tt, tt-ru, tw, twq, twq-ne, ty, tzm, tzm-ma, ug, ug-cn, uk, uk-ua, ur, ur-in, ur-pk, uz, uz-af, uz-uz, vai, vai-lr, ve, vec, vec-it, vi, vi-vn, vmw, vmw-mz, vo, vo-001, vun, vun-tz, wa, wae, wae-ch, wo, wo-sn, xh, xh-za, xnr, xnr-in, xog, xog-ug, yav, yav-cm, yi, yi-001, yi-ua, yo, yo-bj, yo-ng, yrl, yrl-br, yrl-co, yrl-ve, yue, yue-cn, yue-hk, yue-mo, za, za-cn, zgh, zgh-ma, zh, zh-cn, zh-hans, zh-hant, zh-hk, zh-mo, zh-my, zh-sg, zh-tw, zu, zu-za
publishedDateJSONOptional
publishedDate (anyOf 1)integerAlternativeThe date the content was published.
Format: int64
publishedDate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rowIdJSONOptional
rowId (anyOf 1)integerAlternativeIf a dynamic page, the row ID in the HubDB table.
Format: int64
rowId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
scoreJSONRequired within parent
score (anyOf 1)numberAlternativeThe matching score of the document.
score (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
subcategorystringOptionalFor knowledge articles, the subcategory of the article.
tableIdJSONOptional
tableId (anyOf 1)integerAlternativeIf a dynamic page, the ID of the HubDB table.
Format: int64
tableId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tagsarrayOptionalIf a blog post, the tags associated with it.
tags[]stringEach item
titlestringOptionalThe title of the returned document.
typestringRequired within parentThe type of document. Can be `SITE_PAGE`, `LANDING_PAGE`, `BLOG_POST`, `LISTING_PAGE`, or `KNOWLEDGE_ARTICLE`.
Known values: BLOG_POST, KNOWLEDGE_ARTICLE, LANDING_PAGE, LISTING_PAGE, SITE_PAGE, STRUCTURED_CONTENT
urlstringRequired within parentThe url of the document.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.