Navigation: Catalog: SiteSearch3 > Schemas

SiteSearchTagsSearchByQuery

Search your site.Returns any website content matching the given search criteria for a given HubSpot account. Searches can be filtered by content type, domain, or URL path.

Catalog: SiteSearch3

Schema: Public

Label: {res:itgen_hubspot_sitesearchtagssearchbyquery_plural}

This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function SiteSearchTagsSearchByQuery. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Data Type	Required	Documentation
autocomplete	boolean	☐	Specifies whether or not you are showing autocomplete results. Defaults to false.
boostLimit	decimal	☐	Specifies the maximum amount a result will be boosted based on its view count. Defaults to 5.0. Read more about elasticsearch boosting [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-boost.html).
boostRecent	string	☐	Specifies a relative time window where scores of documents published outside this time window decay. This can only be used for blog posts. For example, boostRecent=10d will boost documents published within the last 10 days. Supported timeunits are ms (milliseconds), s (seconds), m (minutes), h (hours), d (days).
hubdbQuery	string	☐	Specify a HubDB query to further filter the search results.
language	string	☐	Specifies the language of content to be searched. This value must be a valid [ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `es` for Spanish) (Waarden: af, af-na, af-za, agq, agq-cm, ak, ak-gh, am, am-et, 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, az, az-az, bas, bas-cm, be, be-by, bem, bem-zm, bez, bez-tz, bg, bg-bg, 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, chr, chr-us, ckb, ckb-iq, ckb-ir, cs, cs-cz, cu, cu-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, 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-de, en-dg, en-dk, en-dm, en-er, en-fi, en-fj, en-fk, en-fm, en-gb, en-gd, en-gg, en-gh, en-gi, en-gm, en-gu, en-gy, en-hk, en-ie, en-il, en-im, en-in, en-io, 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-mw, en-mx, en-my, en-na, en-nf, en-ng, en-nl, en-nr, en-nu, en-nz, en-pg, en-ph, en-pk, en-pn, en-pr, en-pw, en-rw, en-sb, en-sc, en-sd, en-se, en-sg, en-sh, en-si, en-sl, en-ss, en-sx, en-sz, en-tc, en-tk, en-to, en-tt, en-tv, en-tz, en-ug, en-um, en-us, en-vc, en-vg, en-vi, 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, 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, fur, fur-it, fy, fy-nl, ga, ga-gb, ga-ie, gd, gd-gb, gl, gl-es, 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, hi, hi-in, hr, hr-ba, hr-hr, hsb, hsb-de, hu, hu-hu, hy, hy-am, ia, ia-001, id, ig, ig-ng, ii, ii-cn, id-id, is, is-is, it, it-ch, it-it, it-sm, it-va, he-il, ja, ja-jp, jgo, jgo-cm, yi, yi-001, jmc, jmc-tz, jv, jv-id, ka, ka-ge, kab, kab-dz, kam, kam-ke, kde, kde-tz, kea, kea-cv, khq, khq-ml, ki, ki-ke, kk, kk-kz, kkj, kkj-cm, kl, kl-gl, kln, kln-ke, km, km-kh, kn, kn-in, ko, ko-kp, ko-kr, kok, kok-in, ks, ks-in, ksb, ksb-tz, ksf, ksf-cm, ksh, ksh-de, kw, kw-gb, ku, ku-tr, ky, ky-kg, lag, lag-tz, lb, lb-lu, lg, lg-ug, lkt, lkt-us, 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, mer, mer-ke, mfe, mfe-mu, mg, mg-mg, mgh, mgh-mz, mgo, mgo-cm, 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, naq, naq-na, nb, nb-no, nb-sj, nd, nd-zw, nds, nds-de, nds-nl, ne, ne-in, ne-np, nl, nl-aw, nl-be, nl-ch, nl-bq, nl-cw, nl-lu, nl-nl, nl-sr, nl-sx, nmg, nmg-cm, nn, nn-no, nnh, nnh-cm, no, no-no, nus, nus-ss, nyn, nyn-ug, om, om-et, om-ke, or, or-in, os, os-ge, os-ru, pa, pa-in, pa-pk, pcm, pcm-ng, 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, 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, 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, smn, smn-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, su, su-id, sv, sv-ax, sv-fi, sv-se, sw, sw-cd, sw-ke, sw-tz, sw-ug, sy, 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, to, to-to, tr, tr-cy, tr-tr, tt, tt-ru, twq, twq-ne, tzm, tzm-ma, ug, ug-cn, uk, uk-ua, ur, ur-in, ur-pk, uz, uz-af, uz-uz, vai, vai-lr, vi, vi-vn, vo, vo-001, vun, vun-tz, wae, wae-ch, wo, wo-sn, xh, xh-za, xog, xog-ug, yav, yav-cm, yo, yo-bj, yo-ng, yue, yue-cn, yue-hk, zgh, zgh-ma, zh, zh-cn, zh-hk, zh-mo, zh-sg, zh-tw, zh-hans, zh-hant, zu, zu-za)
length	string	☐	Specifies the length of the search results. Can be set to `LONG` or `SHORT`. `SHORT` will return the first 128 characters of the content's meta description. `LONG` will build a more detailed content snippet based on the html/content of the page. (Waarden: SHORT, LONG)
matchPrefix	boolean	☐	Inverts the behavior of the pathPrefix filter when set to `false`. Defaults to `true`.
popularityBoost	decimal	☐	Specifies how strongly a result is boosted based on its view count. Defaults to 1.0.
q	string	☐	The term to search for.
tableId	int64	☐	Specifies a specific HubDB table to search. Only returns results from the specified table. Can be used in tandem with the `hubdbQuery` parameter to further filter results.

Columns of Table Function

The columns of the table function SiteSearchTagsSearchByQuery are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
authorFullName	string	Author Full Name	☐	Name of the author.
category	string	Category	☐	For knowledge articles, the category of the article.
combinedId	string	Combined ID	☐	The ID of the document in HubSpot.
description	string	Description	☐	The result's description. The content will be determined by the value of `length` in the request.
domain	string	Domain	☐	The domain the document is hosted on.
featuredImageUrl	string	Featured Image URL	☐	URL of the featured image.
id	int32	ID	☐	The ID of the content.
language	string	Language	☐	The document's language.
publishedDate	int64	Published Date	☐	The date the content was published.
rowId	int64	Row ID	☐	If a dynamic page, the row ID in the HubDB table.
score	decimal	Score	☐	The matching score of the document.
subcategory	string	Subcategory	☐	For knowledge articles, the subcategory of the article.
tableId	int64	Table ID	☐	If a dynamic page, the ID of the HubDB table.
TEXT	string	Text	☐
title	string	Title	☐	The title of the returned document.
type	string	Type	☐	The type of document. Can be `SITE_PAGE`, `LANDING_PAGE`, `BLOG_POST`, `LISTING_PAGE`, or `KNOWLEDGE_ARTICLE`.
url	string	URL	☐	The url of the document.

18-12-2024 20:09 Version 24.1.33-BETA+5180

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

HubSpot API Data Model

SiteSearchTagsSearchByQuery

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information