Statistics
Indx collects e-commerce-shaped search statistics per dataset: which searches happen, which
results get chosen, and which choices convert. Searches are counted by the server itself — you
send only what the server cannot see: the click and the conversion. A search counts when it has
text and ran: one the server refused (a reason in the response) or that timed out is not
search data, and is not counted. An empty search with a filter counts as browsing, reported per filter value. An empty
search without one, such as a browse page opening, is not counted, and neither are searches
from the web console's own search preview. The dataset's Statistics
tab in the web console shows the same numbers these endpoints serve.
How the pieces connect
- Every search response carries an
Indx-Query-Idheader — an opaque id for that one search. It is CORS-exposed, so a browser client can read it:
const response = await fetch(searchUrl, { ...});
const queryId = response.headers.get('Indx-Query-Id');-
When the user clicks a result, send a select with that id, the document's key and its 1-based position. When something valuable happens — an order, an add-to-cart — send a convert.
-
Aggregates come back from the
statistics/*endpoints, merged over rolled-up days and live events.
A Search-level key (the one already in your storefront) is enough to send events; reading
statistics needs a Read key. Events answer 202 Accepted — they are queued and batch-written.
Sending events
POST /api/teams/{teamName}/datasets/{dataSetName}/events/select
curl -X POST https://your-host/api/teams/acme/datasets/products/events/select \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"queryId": "cf55aa99…", "documentKey": 42, "position": 1, "subject": "customer-123"}'POST /api/teams/{teamName}/datasets/{dataSetName}/events/convert
curl -X POST https://your-host/api/teams/acme/datasets/products/events/convert \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"documentKey": 42, "type": "order", "subject": "customer-123"}'| Field | ||
|---|---|---|
queryId | optional | The value from the search response's Indx-Query-Id header. Optional on convert — an order may come long after the search, or from another channel; it still counts on the document. An unknown or expired id is accepted too: the event keeps its counts and just finds no search to join |
documentKey | required | The document's key |
position | select only, required | 1-based position of the clicked result in the list |
type | convert only, required | Your own name for the event: "order", "addToCart", "signup", … |
value, currency, quantity | optional | Accepted and stored, not reported. Indx counts conversions as a search signal; what an order was worth belongs in your own systems |
subject | optional | See below |
count | optional | false for an event that is not a visitor's (a test, an agent). An event on a search that was sent with count=false is not counted either way |
Checking that clicks join their search
The event posts answer 202 before the event is written, and an unknown queryId is accepted,
so the answer cannot tell you whether the click found its search. The reads can, within a few
seconds (events are written in batches every couple of seconds, and the reads include them at
once):
- Search for something unusual and click a result, with the
Indx-Query-Idof that response asqueryId. GET …/statistics/queries/documents?days=1&text=<the query>lists the document you clicked. A click that joined its search is counted on the query; one that did not is counted on the document only, so it shows instatistics/documentsand not here.
Run the check counted: a search sent with count=false, and every click on it, is left out of
the reads by design. A test dataset, or a single counted search you can live with, does it.
The session
Search-as-you-type sends a search on every keystroke, so typing "oslo" sends o, os, osl
and oslo. Send the same session on each of them and only the one the visitor settled on is
counted:
POST …/search?session=8f3a1cThe session also merges repeats. A front-end often sends the same search more than once: again
with facets after a short delay, for a new sort, or to load more. The same session sending the
same text and filter within 30 seconds is one search, and the click counts on the last one, so
keep the Indx-Query-Id of the latest response. A request for no records
(maxNumberOfRecordsToReturn: 0) is not counted at all.
A session is any random id you create per page load. It identifies no one, and it is never shown or stored anywhere but next to the search. Without one, the server can only leave out single letters, so the prefixes of longer queries are counted. A search that got a click is always counted.
A page rendered on the server needs a session too. Without a cookie there is no visitor to follow, so make the id per page view: create it when the results page is first rendered, and carry it in the links and forms that page sends, so paging, a new sort or a facet click repeat it. Without one, each of those counts as another search, and a popular query reads as more searches, with a lower click-through, than it had. The server does not merge searches without a session on its own: on a busy page, two visitors searching the same thing at the same time are two searches.
A strict search with a fuzzy retry is one search in one session. A common pattern searches
with candidates.fallback: false first, so an empty answer is a trustworthy no-match, and only
then again with the fallback on, showing those results as guesses. Send both with the same
session: they are the same text and filter, so they count as one search, the retry is the one
kept, and a click on one of its results counts as a fuzzy find. Sent without a session they
are two searches, one of them a search that found nothing.
Journeys, and a value picked from a facet's search
The session is also what Statistics follows a visit by. The web console's Journeys section
shows how visits went on from how they started (a search, a catalogue page, a value picked from a
facet) to a chosen result, a conversion or nothing. Only searches sent with a session are in it;
Browsing needs none and holds every search.
When a visitor finds a filter value by typing into the facet's own search field
(POST …/facets/{field}/search) and ticks it, send what they picked with the search that tick
makes, and the visit's journey shows it as a step with what was typed:
POST …/search?session=8f3a1c&pickField=actors&pickValue=Tom%20Hanks&pickText=tom%20hnks&pickFallback=truepickFallback=true says the value came from the closest matches, no value holding every word
typed: a name typed that way often is a spelling the data does not hold. The value must be in the
search's filter. Nothing is stored for what is typed into a facet without a pick. intrface's
ValueFilterPanel sends all of this by itself.
The surface, and searches that should not count
A dataset can have several ways in: a search box in the header, a product finder, an app. Name
the one a search came from with source, and it is stored with the search and counted as usual:
POST …/search?session=8f3a1c&source=headerA search that is not a visitor's - an agent checking what a query returns, a monitor, a test -
sends count=false. It is stored, with its source, but left out of every statistic, the way the
web console's own search preview is (stored as source console). A select or conversion on such
a search is not counted either.
POST …/search?source=monitor&count=falseThe subject
subject is one opaque string you define: an end-user id, a session id, or a customer
segment. Send it on searches too (POST …/search?subject=customer-123) and the same statistics
serve per-user personalization ("top 10 for this user"). Omitted means anonymous — don't invent
a placeholder value; anonymous events are counted honestly as anonymous.
DELETE …/statistics/subjects/{subject} is the GDPR erasure: the subject's personalization
rows are deleted and its raw events anonymised, so aggregate counts stay true while nothing ties
them to the subject any more.
Reading statistics
All reads take ?days= (default 30) and need a Read-level key.
Days, in your time zone
A day runs from midnight to midnight in the dataset's time zone: UTC unless you choose another,
or unless the server's operator set a default (Statistics:TimeZone). Every read counts in it,
days=7 is the last seven of its days, today included, and from/to on a delete are its days.
A Norwegian shop sets Oslo, and an evening search lands on the evening's day:
PUT …/statistics/settings {"timeZone": "Europe/Oslo"}The name is an IANA time zone. "" goes back to the default, and a name that is not a time zone
is a 400. Changing it counts again every day whose searches are still kept, 90 days by default;
older days keep the zone they were counted in. In the web console the choice is on the
Options tab.
One surface at a time
overview, timeseries, queries, queries/documents, documents and filters take
?source=, and then count the searches sent with that source alone:
GET …/statistics/overview?days=7&source=typeahead
GET …/statistics/overview?days=7&source=booksA click or conversion counts for the surface of the search it names by queryId; one sent
without a queryId belongs to no surface and is counted only in the totals. A source no search
was sent with gives zeros, not the totals. A read for one surface comes from the stored searches,
so it reaches back as far as they are kept, 90 days by default.
GET …/statistics/sources lists the surfaces in the window, most searched first, with their
searches counted as the overview counts them. A surface where visitors only browsed (a filter, no
text) is listed with 0 searches. Searches sent without a source are the row with
"source": null:
[ { "source": "typeahead", "searches": 180 }, { "source": "books", "searches": 52 },
{ "source": null, "searches": 3 } ]The web console's Statistics tab has the same choice, as a selector beside the period once any search has named its surface.
GET …/statistics/overview — the headline numbers:
{
"searches": 1204, "uncovered": 96, "uncoveredRate": 0.08, "uncoveredChosen": 41, "clickedSearches": 311,
"selects": 402, "converts": 58, "clickThroughRate": 0.258, "averageClickPosition": 2.4,
"zeroHits": 37, "zeroHitRate": 0.031
}Fuzzy finds are where Indx earns its keep. uncovered counts the searches that counted
nothing: no record held every word within the edits allowed, so what the visitor saw was the
fallback (the records holding the most of the words, then pattern matches), or nothing.
uncoveredChosen counts the ones where the visitor chose a result anyway, the searches the
fallback answered. zeroHits remains for compatibility. A search with no word lookup to count with
(Bm25f, a query with no word long enough, a dataset with no field matched by its words) is not
counted as uncovered, since there is nothing to tell.
Rates are computed server-side so every consumer shares the definitions: click-through counts
searches with at least one select against all searches (zero-hit ones included), and a rate
whose denominator is zero is null, never 0%.
GET …/statistics/timeseries — one row per day ("date": "2026-09-29"), zero rows
included so charts have no holes.
GET …/statistics/queries?limit=50 — top queries with searches, selects, click-through and
average click position per query. order= picks the order: searches (the default),
lowestClickThrough (searched often and chosen from rarely, so either the dataset lacks what
people want or ranks it too low), highestClickThrough, and chosenAnyway with
uncoveredOnly=true. The two click-through orders leave out queries searched fewer than five
times, where one click reads as a rate of 100 %.
GET …/statistics/queries/documents?text=lamp lists, for one query, every document chosen from
its results, most chosen first, with how often, the sum of the positions it was chosen at, and
the conversions from the same searches. It tells a query that found the thing people meant from
one that only offered a substitute. Read from the raw events, so up to 90 days back by default.
GET …/statistics/queries?uncoveredOnly=true — the misspelled searches behind the console's
Fuzzy search section, each with uncovered (how often), uncoveredChosen (how often a
result was chosen anyway) and mostChosenDocument, the result chosen most.
GET …/statistics/documents?limit=50 — top documents by selects, with conversions.
GET …/statistics/filters?limit=50 — browsing: how often people narrowed by each filter value,
with or without text, and how often that left them nothing. A combined filter counts once per
value in it; a range filter is reported by its field, with an empty value.
Browsing stores the filter of every search. On a dataset of people a filter value can be a name
or a customer number, so it can be switched off per dataset: PUT …/statistics/settings with
{"recordFilters": false} (Full key, team admin), or the Options tab in the web console.
Switching it off stops the recording; filter values already recorded stay until they age out of
retention or the dataset's statistics are erased. GET …/statistics/settings reads the setting;
it is on by default.
GET …/statistics/subjects/{subject}?limit=10 — one subject's lifetime top documents.
Names beside the keys
documents, queries/documents and subjects/{subject} give each document a label beside its
documentKey, and the misspelled-query list a mostChosenLabel: the value of one field, so a
report can say which book rather than which number. It is the first searchable field (usually
the title) unless you choose another:
PUT …/statistics/settings {"labelField": "title"}A nested field goes by its dotted path (author.name); an array field gives its first three
values. "" goes back to the first searchable field, and a field the dataset does not have is a
400. A property you leave out of the PUT stays as it is, so this does not touch
recordFilters. The label is read from the loaded index, and a statistics read never wakes a
sleeping dataset: while it sleeps, label is null and the key stands alone. In the web console
the choice is on the Options tab, beside the Browsing setting.
What changed, beside the numbers
When a number moves, the first question is what changed. Indx records the changes made to the dataset itself, so the answer sits next to the chart: synonyms saved, boost rules saved, fields changed, a reindex, a replace, the dataset hibernating or waking, a rename. Document inserts, updates and deletes are counted per day, and a single request that changes many documents at once (a thousand, or a tenth of the dataset if that is fewer) is recorded on its own, as is every delete-by-filter and update-by-filter. Configuring a dataset before its first index is setup, not a change, and is not recorded.
Only what changed and when is kept: counts and field names. Never the content, and never who made the change. In the web console the changes are small marks under the chart on the Statistics tab, with a list below it.
GET …/statistics/changes?days=30 — the window's changes, oldest first, each with at (UTC),
kind and a small summary, and the document totals per day:
{
"changes": [
{ "at": "2026-09-12T08:41:03Z", "kind": "synonyms", "summary": { "entriesBefore": 34, "entries": 44 } },
{ "at": "2026-09-14T02:04:51Z", "kind": "documents",
"summary": { "operation": "deleteByFilter", "inserted": 0, "updated": 0, "deleted": 19000, "documents": 28000 } }
],
"documents": [ { "date": "2026-09-14", "inserted": 0, "updated": 5200, "deleted": 19000 } ]
}Lifecycle and retention
Statistics are keyed on the team and the dataset name — the same way document keys are
yours — so they survive dataset deletion and recreation under the same name, a zero-downtime
replace continues them seamlessly, and a dataset moved to another team takes them along. DELETE …/statistics (Full key, team Admin) is the one
explicit way to start clean, and it deletes the change history too. In the web console it is
on the dataset's Options tab.
To remove test traffic without losing the real history, delete part of it instead:
DELETE …/statistics?source=deploy-check one surface's searches
DELETE …/statistics?from=2026-10-06&to=2026-10-06 the searches of those days (inclusive)
DELETE …/statistics?source=deploy-check&from=2026-10-06 bothEach takes the searches it selects with their clicks and conversions, and keeps what the owners
changed. By days, the daily totals of those days go too. By source, a select or conversion goes
with the search it names by queryId, and the daily totals are counted again from what is left;
days older than the raw events (90 days) keep that surface's share. A day that is not a date, or
from after to, is a 400 and deletes nothing.
Raw events are kept 90 days (operator-configurable) and rolled up into daily aggregates that
are kept until deleted. When the operator has switched the feature off, every route here answers
404 with code statisticsDisabled.
BoostRules
CreateBoost will create a Boost setup which may be passed to any search.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Returns the dataset's persisted boost rules (server-side ranking rules applied when a search sets enableBoost). Config, not state-gated — available even when not Ready.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Replaces the dataset's boost rules (whole list). Each rule needs a name, at least one condition, and every condition must reference a Filterable field and be either a value match or a numeric range (not both).
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object[] |
Clears all boost rules for the dataset.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
BuryRules
A bury for the documents a filter holds, to send in a search's `buries`.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
The dataset's saved bury rules.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Replaces the dataset's saved bury rules.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object[] |
Deletes all the dataset's saved bury rules.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Cold
A record's cold storage, without content: its table of contents, its reviews.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
documentKey | path | int64 | Yes |
api-version | header | string | No |
api-version | query | string | No |
One item with its content.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
documentKey | path | int64 | Yes |
name | path | string | Yes |
language | query | string | No |
api-version | header | string | No |
api-version | query | string | No |
Writes an item, created or replaced whole. `If-Match` with the version read refuses the write (409) when another changed the item since. The record need not be loaded yet: a sync may write the items before the catalogue; an item whose record is not there is left out when read.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
documentKey | path | int64 | Yes |
name | path | string | Yes |
language | query | string | No |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Deletes an item (204; 404 when there was none).
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
documentKey | path | int64 | Yes |
name | path | string | Yes |
language | query | string | No |
api-version | header | string | No |
api-version | query | string | No |
A sync's batch for the dataset's records: each item written as a single PUT writes it, and with `prune=true` the items this caller wrote on the dataset before and did not send now are deleted, so a backend keeps its share in step without touching anyone else's. 200 with the outcome of each item in order; refused ones are said, the others are written.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
prune | query | boolean | No |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object[] |
DatasetExport
Downloads every document in the dataset as one JSON array, ordered by document key — the records as they were loaded, replaced or last updated, including fields that are not configured. Streams, so it works on a dataset of any size, and works whether the dataset is Ready, hibernated or idle-evicted. Any team member may export. Field configuration and boost rules are separate exports. `progress` is the console's: a token it counts the written records under, for its progress bar. Leave it out.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
progress | query | uuid | No |
api-version | header | string | No |
api-version | query | string | No |
Datasets
As Analyze but handles a stream as input text.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Analyze the fields of a string containing json. Since json may be invalid, which will cause a 400 error, it is sent as plain text.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | string |
Creates the data set (201). Idempotent: an existing data set is left exactly as it is and answers 200. There is no longer a `configuration` query parameter — there was one configuration to choose from, so choosing was theatre. Clients that still send `?configuration=400` (every published `@indxsearch/intrface` does) are unaffected: a query value that binds to nothing is ignored, which `UnknownQueryParameterTests` pins. Note the one behaviour change that comes with it — a garbage value used to be a validation 400 from enum binding and is now simply ignored, which is safe only because the value no longer reaches anything.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
DeleteDataSet, will delete the entire dataSet including all contained Documents. Requires team Admin.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
GetStatus will return the status of the dataSetName in the search engine.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Returns all datasets the current user can reach via team membership, across every team they belong to. Each entry carries the owning team name and the caller's role on it.
| Name | In | Type | Required |
|---|---|---|---|
api-version | header | string | No |
api-version | query | string | No |
Lists the datasets owned by a single team.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
IndexDataSet starts the index build and answers 202 with the status as it is then; the build goes on in the background. A Loaded dataset is indexed for the first time: poll GET status until `systemState` is Ready (a build that fails leaves the state it fell back to and `errorMessage`). A Ready dataset is rebuilt on a shadow engine and keeps serving meanwhile: poll until `shadowBuildInProgress` is false, then read `shadowBuildError`. Until Oct 2026 the request waited for the build.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Loads the jsonData into search engine from the database.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Loads the jsonData into search engine as a stream.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Atomically replaces the entire dataset's documents with the streamed JSON. Unlike delete+recreate this preserves the dataset's identity, field configuration, boost rules and description, serves the old data with zero downtime until the new index is ready, and leaves the old dataset untouched if the new JSON fails to build. Works whether the dataset is Ready, hibernated or idle-evicted (the old documents are never reloaded). Returns a summary of how the new schema differed from the previous field configuration.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Loads the jsonData into search engine as a string.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | string |
Hibernates the dataset: everything leaves memory while the documents stay in the store. The dataset reports Created with recordsOnDisk > 0 afterwards, and WakeUp — or, for a timed/pinned dataset, simply the next access — restores it.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Wakes a hibernated dataset — Created with records in the store — by reloading the documents from the store and rebuilding the index. The same operation the console's Wake button runs, so its progress shows there too.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Documents
Deletes a document from the dataset by its key.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
documentKey | path | int64 | Yes |
api-version | header | string | No |
api-version | query | string | No |
Inserts one single Json record. The route key must match the document's key field (the engine keys documents from the body, so a disagreeing route would otherwise silently insert under a different key than the URL claims).
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
documentKey | path | int64 | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | string |
Updates one single Document. The route key must address an existing document and match the document's key field (the engine keys documents from the body, so a disagreeing route would otherwise silently update a different document than the URL claims).
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
documentKey | path | int64 | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | string |
Updates a single field on a document identified by its key.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
documentKey | path | int64 | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Deletes documents from the dataset by their keys.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | int64[] |
Inserts new JSON records into the dataset.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | string[] |
Updates existing JSON records in the dataset.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | string[] |
Returns the raw json records as string[] for the keys, in their order; a key no record has gives an empty string. A search answer's records give their keys (`records.map(r => r.documentKey)`). start and length read a part of the keys (all by default), a page of a result; a part outside them answers 400 with what was wrong.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
start | query | int32 | No |
length | query | int32 | No |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | int64[] |
Returns the number of JSON records in the database for the given dataset.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Deletes all documents matching the given filter.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Updates a field on all documents matching the given filter. Returns the number of updated documents.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Events
The user chose a result: the document, its 1-based position, and optionally the queryId from the search response's Indx-Query-Id header and a subject.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Something the customer considers valuable happened for a document: an order, an add-to-cart — the type is theirs. QueryId is optional; without it the conversion still counts on the document.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Fields
GetAllFields will return the fields found during analyze.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
GetFacetableFields will return the array of facetable field names.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
GetFilterableFields will return the array of filterable field names.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
GetSortableFields will return the array of sortable field names.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
GetEmbeddableFields will return the array of embeddable (vector) field names.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
SetFieldConfiguration sets any combination of field properties (WordMatching, Filterable, Facetable, Sortable, Embeddable, PreloadFilters, Weight, BM25b, BM25k1, PatternMatching, IndexSizes, NumberOfStartCharacters, NumberOfStopCharacters) in one call. Nullable properties have replace semantics: null = leave untouched, any value (including false) = overwrite. The whole request is checked before anything is changed, and a refused one is a 400 that changes nothing. An accepted one answers in one of two ways. <b>204</b>: the change is applied, which is every change on a dataset that is not serving yet and a change of query-time roles on one that is. <b>202</b> with the status: the change needs the index rebuilt on a dataset that is Ready, so a rebuild on a shadow engine has been started and the dataset serves with the old configuration until it is swapped in. Poll GET status until `shadowBuildInProgress` is false, then read `shadowBuildError`: null means the new configuration is in use. Until Oct 2026 the request waited for the rebuild, minutes on a large dataset.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object[] |
GetFieldConfiguration returns the full configuration of every field in the dataset. Search level, not Read: a filter panel needs each field's type to know whether a selected value is a value filter or a range with equal limits, and the name lists it reads today do not carry it. A Search key can already search and read documents, so the types and sample values here reveal nothing it does not see.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
The dataset's field profiles (Nov 2026): every profile, the five built-ins (marked when this dataset changed one) and its own, each with the fields that have it; which field has which; the searched fields with settings of their own (no profile); and the profile a field gets when it becomes searched. A profile is a searched field's Tolerance, RerankWeight and pattern setup under one name, as the console's Profile manager shows it.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Sets the dataset's field profiles (Nov 2026), and writes each profile's values onto the fields that have it. Body: `{ profiles, assignments, defaultProfileId }`, each left as it is when left out. `profiles` is the dataset's own list, whole: an entry with a built-in's id (title, name, category, code, text) changes that built-in here; one left out is deleted, its fields keeping their values as their own. `assignments` maps field names to a profile id, or to null for none; the field must be searched (wordMatching or patternMatching on). `defaultProfileId` is the profile a field gets when it becomes searched, name by default. The request is checked whole and a refused one is a 400 that changes nothing. The fields' new values go the way PUT fields/configuration takes them: <b>204</b> when applied, <b>202</b> with the status when a pattern setup changed on a Ready dataset and the index is rebuilt on a shadow engine (poll GET status until `shadowBuildInProgress` is false).
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Returns the dataset's declared key field — the JSON field whose value identifies each document (the primary key). Empty string means none is declared (the engine auto-generates keys). Required, when set, to be a numeric field.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Declares the dataset's key field (the JSON field whose value is each document's primary key). Pass an empty string to clear it (auto-generated keys). The field must be numeric. The choice is preserved across reloads and applied on the next Load/replace; documents already loaded keep their existing keys until the data is reloaded.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | string |
Filters
Combines two or more filters with AND or OR into one: one node and one token for the whole list, where pairs combined in turn were a request and a filter per pair. A filter listed twice counts once and the order does not matter; one filter gives its own token.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
NegateFilter returns a filter matching every document the given filter does not: the NOT of a value, range or combined filter. The result is a token like any other and can be combined further.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
CreateRangeFilter will create a RangeFilter which may be passed to any search.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Creates the filter a filter expression describes, e.g. `brand IN ["nike", "puma"] AND price BETWEEN 100 AND 2000`, and answers its token and the expression as the engine reads it. The token is the one the other filter routes make for the same filter. An expression that makes none is 400 `invalidFilterExpression` with every error and its place; a placeholder's token that does not resolve is 400 `unknownFilter`.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Creates a filter matching documents whose field holds one of a set of values - one filter for the whole set, where value filters combined with OR are 2n - 1 requests and filters. Like a value or range filter, its token describes it.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Creates a filter matching documents whose position lies within a distance, in metres, of the given position. The position field is an object with the numbers `latitude` and `longitude`, both Filterable. Like a range filter, its token describes it.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
CreateValueFilter will create a ValueFilter which may be passed to any search. Case-insensitive unless `isCaseSensitive` is set; see Indx.Http.ValueFilterProxy for when it should be, and what it costs.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Deletes a single filter from the filter cache.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Deletes all filters from the filter cache.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Pre-loads all registered filters in the background.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Returns the number of filters currently registered in the filter cache.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
QueryParameters
Returns what the dataset sets (`parameters`, null where it sets nothing) and what a search that sends none of these values runs with (`effective`, every value filled in). Config, not state-gated: available while the dataset is asleep. A search key may read it: it says how this dataset's searches run, and a search page shows it beside its own values.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Replaces the dataset's query parameters. A value left out (or null) is not set, and a search that leaves it out too gets the engine default. Applies from the next search; no reindex.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Clears the dataset's query parameters: searches get the engine defaults again.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Search
Search will validate the search query and return the search result. With `includeDocuments` the records' JSON comes with it, in `documents`, in the order of `records` (null for a record gone since), so a search is one call, not two; `includeFields` keeps only the fields named.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Several searches of the dataset in one call, answered in the order sent: what an InstantSearch page asks for at once, its list and the counts of each refined OR facet without that facet's own filter (11 Nov 2026, backlog 90 step 4). Each runs as M:IndxServer.Controllers.SearchController.Search(System.String,System.String,IndxServer.Models.ServerQueryProxy) runs it, the statistics and the query string's parameters included; a search that fails is an `error` in its place, with the status and problem a single search would have answered, and the others are answered. Each answer carries its `queryId` where a single search's header would. At most IndxServer.Controllers.SearchController.MaxSearchesPerCall searches. A search may say for itself whether it counts in the statistics, and its source and session (`count`, `source`, `session` in its body), over the query string's: a page sends its visitor's search beside its helper searches and counts only the first (12 Nov 2026). `Server-Timing` gives the searches' time together. The engine searches them in one call, at once on the search slots it has free and one after the other when none is (ISearchEngine.Search(Query[]), 12 Nov 2026); `Server-Timing`'s search is the time until the last is answered.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object[] |
One text, answered in named sections: a search box's products, brands, articles and pages in one call, each section with its own filter (ANDed with the search's), rows and count (12 Nov 2026: one search per keystroke instead of several). A section may count by another filter than it lists (`countFilter`: list the ones in stock, count them all), and take its own candidates, ranking and match. The answer is `{ "groups": { name: result }, "queryId" }`, each result as a single search's, a section that fails an error in its place. One search in the statistics: the section marked `primary`, else the first, whose `queryId` (also the `Indx-Query-Id` header) a click in any section references. Each section is its own search in the engine, all of them searched in one call, at once on the free search slots (ISearchEngine.Search(Query[]), 12 Nov 2026); were the library to match once for them all, the request and answer would stay as they are.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Searches the values of a facetable field, for a long facet's own search field ("Search actors…", InstantSearch's searchable refinement list): the values that match what was typed, with Indx's matching (typos, word starts, whole words anywhere in a value), each with how many records hold it, the most first (FacetValueIndex, 14 Nov 2026). With `search` the counts are of that search's records, as its facet would count them, and a value it holds none of is left out; a field ticked in its `facetSelections` is counted without its own ticks, as InstantSearch asks. Answers `{ values: [{ value, count }], exhaustive }`; the counts are exact. Nothing goes into the statistics.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
field | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Searches a single embedding field using approximate nearest-neighbour search.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Combines text search with embedding nearest-neighbour search and blends scores.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
SearchOrAsk
What the dataset sets, what it runs with (the site description and fields after defaults), and whether a page can run it here (`available`: a model key is configured and the dataset shows it). A search key may read it: a search page needs to know whether to ask, and the thresholds.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Replaces the dataset's settings. Applies from the next call; no reindex.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Removes the dataset's settings: the feature is off and every value back to its default.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Whether this dataset has Search or ask (its Options tab): a team admin's switch. Experimental, so off by default; on, the dataset's tab and its visitor routes appear, and `enabled` in the settings then takes it live.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Judges what a visitor has typed so far: `p`, the probability they are asking for something an answer would serve, `answerable`, whether the results could answer it, and the `offer` those come to on their own. Call it on a typing pause, beside the search the page already ran. A judge that is slow or failing answers `p` 0 with a `reason`; it never fails the call. With `prefetch` true, call it while the visitor types as well, one call in flight at a time: the judge reads the text ahead of the pause and keeps its answer, so the pause's own call comes back from that at once. Only the pause's call is a judgement in the statistics.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
A catalogue's description of what to list, as filters on the dataset's own fields: call it when intent's `criteria` reaches the strong threshold. Each filter is a value or a number range on a Filterable field, checked against the values the dataset holds; a text field also needs to be Facetable, which is where its values come from. `text` is what no filter covers, to search for.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Answers a question from the dataset's records, as server-sent events: `sources` (the records the answer may use, numbered), `text` (the answer as it is written, citing sources as [n]), then `done`; or `error` with a code. The answer uses those records and nothing else, and says so when they do not hold it.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
What Search or ask did in the last `days` (today included, in the dataset's time zone): offers shown and taken, questions asked and how they ended, cited sources opened, and what it cost. `questions` lists the questions asked, the ones the content did not answer first; `offered` the texts an offer was shown beside (from the searches the page named), so a false offer can be found. Counted rows only, like every statistics read.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
days | query | int32 | No |
source | query | string | No |
limit | query | int32 | No |
api-version | header | string | No |
api-version | query | string | No |
Statistics
The window's totals and rates - the dashboard's header numbers. Rates are computed here so every consumer shares the definitions (see the response type).
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
days | query | int32 | No |
source | query | string | No |
api-version | header | string | No |
api-version | query | string | No |
The per-day series behind the charts: one row per UTC day in the window. Days without events are served as zero rows, so a chart never has holes.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
days | query | int32 | No |
source | query | string | No |
api-version | header | string | No |
api-version | query | string | No |
Top queries in the window: searches, zero-hit count and selects per query text (lowercased). With uncoveredOnly=true, the searches without coverage: those coverage confirmed nothing for, how often a result was chosen anyway, and the document chosen most (mostChosenDocument), which is usually the synonym or spelling to add. order=lowestClickThrough lists the queries searched often and chosen from rarely (highestClickThrough the reverse; both leave out queries searched fewer than five times, where one click reads as 100%), and order=chosenAnyway with uncoveredOnly the fuzzy finds. With zeroHitsOnly=true, the zero-hit report — the searches the dataset could not answer, ordered by how often.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
days | query | int32 | No |
limit | query | int32 | No |
zeroHitsOnly | query | boolean | No |
uncoveredOnly | query | boolean | No |
order | query | string | No |
source | query | string | No |
api-version | header | string | No |
api-version | query | string | No |
For one query (text, compared lowercased like the query list): which documents visitors chose from its results, most chosen first, with the position sum and the conversions from the same searches. A query searched often and chosen from rarely is either missing what people want or ranking it too low; which of the two, and whether the choices were the thing itself or a substitute, is read from this list. From the raw rows, so as far back as they are kept (90 days by default).
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
text | query | string | No |
days | query | int32 | No |
limit | query | int32 | No |
source | query | string | No |
api-version | header | string | No |
api-version | query | string | No |
Browsing in the window: how often people narrowed by each filter value, with or without text, and how often that came back empty. A combined filter counts once per operand; a range counts by its field, with an empty value.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
days | query | int32 | No |
limit | query | int32 | No |
source | query | string | No |
api-version | header | string | No |
api-version | query | string | No |
Top documents in the window: selects, converts and summed convert value per document key. The keys are the customer's own; titles are looked up by key.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
days | query | int32 | No |
limit | query | int32 | No |
source | query | string | No |
api-version | header | string | No |
api-version | query | string | No |
The surfaces searches came from in the window, most searched first: each `?source=` with its searches, counted as the overview counts them, and a row with a null source for the searches that named none. From the raw rows (90 days by default).
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
days | query | int32 | No |
api-version | header | string | No |
api-version | query | string | No |
One subject's lifetime top documents — the personalization read ("top 10 per user"). The subject is whatever the customer sent on the events.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
subject | path | string | Yes |
limit | query | int32 | No |
api-version | header | string | No |
api-version | query | string | No |
The GDPR erasure of one subject: the subject↔document edge is deleted and the raw rows are anonymised, so aggregate counts stay true while nothing ties them to the subject any more.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
subject | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
What the dataset's owners changed in the window, oldest first, and the daily document totals: the why beside the numbers.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
days | query | int32 | No |
api-version | header | string | No |
api-version | query | string | No |
The dataset's statistics settings. `recordFilters`: whether each search's filter is stored, which is what the Browsing report counts. On by default.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Changes the dataset's statistics settings; a property left out stays as it is. Switching `recordFilters` off stops recording filters; what is already recorded stays until it ages out or the statistics are erased. `labelField` names the field the statistics show beside a document key; `""` goes back to the first searchable field, and a field the dataset does not have is a 400. Team admin, Full key: a privacy setting sits here.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
Deletes the dataset's statistics. Bare, every row: the explicit purge, since statistics survive dataset delete/recreate and starting clean is a choice made here. With `source` and/or `from`/`to` (UTC days, yyyy-MM-dd, inclusive), only the visitor events they select: the searches sent with that source or in those days, with their selects and conversions, so test traffic can go without the real history. The owners' changes and the subjects' lifetime top documents stay then. By source, days older than the raw rows' retention (90 by default) keep that surface's share.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
source | query | string | No |
from | query | string | No |
to | query | string | No |
api-version | header | string | No |
api-version | query | string | No |
Synonyms
Returns the dataset's synonym list, or a `null` body when it has none — always 200. The list widens every search on this dataset: a query word that matches an entry also finds the records holding the entry's other terms, ranked below the records holding the words as typed. One list per dataset — there is no name to supply, and no other dataset is affected.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Sets the dataset's synonym list, replacing any list it already had. Send a body of `null` to remove the list — the dataset then searches without synonyms again. Takes effect on the very next search: synonyms are applied to the query text, so nothing is re-indexed and the dataset does not have to be in any particular state. The list is stored with the dataset, so it survives a restart and follows the dataset if it is transferred to another team. Note that widening a query lowers Coverage scores in proportion to how much text is added — see the remarks on `Indx.Api.SynonymList`.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
WebhookReceiver
| Name | In | Type | Required |
|---|---|---|---|
webhookId | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
The full set, replacing the dataset's documents: a list of documents, or `{ "documents": [...] }`, signed like any call.
| Name | In | Type | Required |
|---|---|---|---|
webhookId | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Webhooks
The sources a webhook can have, with their settings.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Makes a webhook for the dataset. The answer carries its address and its secret, which is shown only here: the sender authenticates each call with it, the way its source does. A dataset without documents yet is filled by the first full sync, which also gives it a key field; a webhook whose source Indx fetches from runs that sync at once.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
The dataset's webhooks, with how many calls wait to be applied and how many batches the brake holds.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Changes a webhook's name, version field, brake and source settings. A secret setting left out keeps the one set. Settings that change what Indx fetches start a full sync. The source, the id field and the secret stay as they are.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
webhookId | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
| Content Type | Schema |
|---|---|
application/json | object |
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
webhookId | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
A new secret, shown once; the old one stops working at once.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
webhookId | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
The latest calls, newest first: what each applied, ignored and refused, and why.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
webhookId | path | string | Yes |
limit | query | int32 | No |
api-version | header | string | No |
api-version | query | string | No |
The batches the brake holds, waiting for an admin to apply or discard them.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
webhookId | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Discards every held batch: nothing in them is applied.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
webhookId | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Applies a held batch as it came, past the brake.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
webhookId | path | string | Yes |
heldId | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Fetches the full set from the webhook's source now and replaces the dataset's documents with it (a Sanity or Contentful webhook). A webhook whose sender pushes its own sync is told where.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
webhookId | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Applies every held batch, oldest first. A busy dataset stops it (409); the batches not yet applied stay held, in their order.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
webhookId | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Discards a held batch: nothing in it is applied.
| Name | In | Type | Required |
|---|---|---|---|
teamName | path | string | Yes |
dataSetName | path | string | Yes |
webhookId | path | string | Yes |
heldId | path | string | Yes |
api-version | header | string | No |
api-version | query | string | No |
Schemas
AskRequest
A question, and for a follow-up the conversation so far (the last three turns are used). `Proactive`: the page started this answer on its own, in the proactive mode, rather than the visitor asking; it counts against the day's proactive answers.
| Property | Type | Default |
|---|---|---|
question | string | — |
history | object[] | — |
proactive | boolean | — |
AskShown
On a catalogue, the list a turn put on the page: its filters, words and order, or the agent's picks. A follow-up ("which is the largest?") is about that list.
| Property | Type | Default |
|---|---|---|
filters | object[] | — |
text | string | — |
sort | object | — |
picks | object[] | — |
AskShownPick
A pick an earlier turn put on the page.
| Property | Type | Default |
|---|---|---|
documentKey | int64 | — |
title | string | — |
AskTurn
An earlier question and its answer in the same conversation, for a follow-up.
| Property | Type | Default |
|---|---|---|
question | string | — |
answer | string | — |
shown | object | — |
BoostCondition
One condition of a boost rule: a filterable field matched either by an exact IndxServer.Models.BoostCondition.Value (string/keyword fields) or by a numeric IndxServer.Models.BoostCondition.Min/IndxServer.Models.BoostCondition.Max range. Exactly one of the two forms is used: if IndxServer.Models.BoostCondition.Min or IndxServer.Models.BoostCondition.Max is set it's a range, otherwise IndxServer.Models.BoostCondition.Value is an exact match.
| Property | Type | Default |
|---|---|---|
field | string | — |
value | string | — |
min | double | — |
max | double | — |
isRange | boolean | — |
BoostProxy
| Property | Type | Default |
|---|---|---|
boostStrength | string | — |
filterProxy | object | — |
BoostRule
A persisted, per-dataset ranking rule: when a search has `enableBoost` on, documents matching this rule's combined condition get their score lifted by IndxServer.Models.BoostRule.Strength. Rules are managed in the UI and applied server-side; see `BoostRuleStore`.
| Property | Type | Default |
|---|---|---|
name | string | — |
enabled | boolean | — |
conditions | object[] | — |
join | string | — |
strength | string | — |
activeFrom | date | — |
activeUntil | date | — |
BuryProxy
| Property | Type | Default |
|---|---|---|
buryStrength | string | — |
filterProxy | object | — |
BuryRule
A saved bury rule, a boost rule's twin (25 Oct 2026): a name, conditions on filterable fields joined by And or Or, a strength, an optional active period. Applied to a search that runs with `enableBury`: the documents the conditions match are scored lower.
| Property | Type | Default |
|---|---|---|
name | string | — |
enabled | boolean | — |
conditions | object[] | — |
join | string | — |
strength | string | — |
activeFrom | date | — |
activeUntil | date | — |
CandidateProxy
| Property | Type | Default |
|---|---|---|
candidatesPerRow | int32 | — |
maxCandidates | int32 | — |
minCandidates | int32 | — |
noFallbackForNumbersFrom | int32 | — |
indexTerms | string | — |
fallback | boolean | — |
rest | boolean | — |
fillWithMostWords | boolean | — |
fillReach | int32 | — |
ChangePasswordRequest
Body of POST /api/changePassword. Used to rotate the seeded admin's initial password (set at deployment time) before any other API calls can be made.
| Property | Type | Default |
|---|---|---|
currentPassword | string | — |
newPassword | string | — |
ColdBatchItem
One item of a sync's batch: IndxServer.Controllers.ColdWrite with the record it is of, by its Indx key (IndxServer.Controllers.ColdBatchItem.RecordKey) or by the sender's own id (IndxServer.Controllers.ColdBatchItem.Id): the id a webhook gave the record, or the record's key as text.
| Property | Type | Default |
|---|---|---|
name | string | — |
content | string | — |
recordKey | int64 | — |
id | string | — |
language | string | — |
contentType | string | — |
description | string | — |
visibility | string | — |
sourceRef | string | — |
sourceUpdatedUtc | date-time | — |
ColdWrite
An item as written: the content and what is said about it. The record, name and language are the route's and the query's; who wrote it is the server's to say.
| Property | Type | Default |
|---|---|---|
content | string | — |
contentType | string | — |
description | string | — |
visibility | string | — |
sourceRef | string | — |
sourceUpdatedUtc | date-time | — |
CombinedFilterProxy
| Property | Type | Default |
|---|---|---|
filters | object[] | — |
useAndOperation | boolean | — |
ConvertEventRequest
The convert event: whatever the customer considers valuable (order, add-to-cart, …). Type is the customer's own name for it. Value/Currency/Quantity are optional commerce magnitudes. QueryId is optional — a conversion may happen long after the search or from another channel, and still counts on the document. Count as for IndxServer.Models.SelectEventRequest.
| Property | Type | Default |
|---|---|---|
queryId | string | — |
documentKey | int64 | — |
type | string | — |
value | double | — |
currency | string | — |
quantity | int64 | — |
subject | string | — |
count | boolean | — |
CreateWebhookRequest
| Property | Type | Default |
|---|---|---|
name | string | — |
idField | string | — |
versionField | string | — |
brakeShare | double | — |
source | string | — |
settings | object | — |
DatasetQueryParameters
A dataset's query parameters: the values a search takes when its request leaves them out. The same shape, names and meaning as those parts of a search body (6.0: `mode`, `match`, `candidates`, `ranking`), so a value can be copied between the two. Null means "not set here", and the engine default applies. Resolution, member by member: the request, then this, then the engine default (IndxServer.Services.QueryParameterResolution). A search's own values are not kept here: the cursor, the index terms, the field weights and boosts, the boosts and buries (M:IndxServer.Services.QueryParameterResolution.Validate(IndxServer.Models.DatasetQueryParameters)).
| Property | Type | Default |
|---|---|---|
mode | string | — |
match | object | — |
candidates | object | — |
ranking | object | — |
DemoCreated
The dataset made, and its name.
| Property | Type | Default |
|---|---|---|
dataSet | string | — |
FacetValueSearchRequest
The body of `facets/{field}/search`: what a visitor typed into a facet's own search field ("Search actors…"), how many values to answer, and the search the facet belongs to, so the counts are of its records.
| Property | Type | Default |
|---|---|---|
text | string | — |
rows | int32 | — |
search | object | — |
values | string[] | — |
FieldProfile
A searched field's search settings under a name many fields share (Nov 2026): its Indx.Api.Field.Tolerance, Indx.Api.Field.RerankWeight, the and the Indx.Api.PatternMatchingSetup it takes when Indx.Api.Field.PatternMatching is on. A console convenience over the engine's own values: choosing a profile for a field writes them onto it, editing a profile writes them onto every field that has it, and the engine stays where the values live. A profile also has the fields' own text rules (Indx.Api.FieldProxy.TextRules, 17 Nov 2026): strings replaced before the dataset's, built into the index, so a change rebuilds it. Indx.Api.Field.CaseSensitive is not here yet.
| Property | Type | Default |
|---|---|---|
id | string | — |
name | string | — |
about | string | — |
builtIn | boolean | — |
tolerance | string | — |
rerankWeight | float | — |
indexSizes | int32[] | — |
numberOfStartCharacters | int32 | — |
numberOfStopCharacters | int32 | — |
typingPrefixFrom | int32 | — |
textRules | object[] | — |
FieldProfilesRequest
PUT fields/profiles. Each part left out (null) is left as it is. `Profiles` is the dataset's own list, whole: a profile with a built-in's id is that built-in as this dataset changes it, one left out of the list is deleted (a built-in back to its shipped values). `Assignments` gives fields their profile by id, or null for none (the field keeps its values, as its own); fields not named keep theirs. `DefaultProfileId` is the profile a field gets when it becomes searched.
| Property | Type | Default |
|---|---|---|
profiles | object[] | — |
assignments | object | — |
defaultProfileId | string | — |
FieldProxy
| Property | Type | Default |
|---|---|---|
fieldName | string | — |
fieldType | string | — |
isArray | boolean | — |
optional | boolean | — |
sampleValue | string | — |
wordMatching | boolean | — |
filterable | boolean | — |
facetable | boolean | — |
sortable | boolean | — |
patternMatching | boolean | — |
embeddable | boolean | — |
preloadFilters | boolean | — |
weight | float | — |
bM25b | float | — |
bM25k1 | float | — |
tolerance | string | — |
typingPrefixFrom | int32 | — |
rerankWeight | float | — |
indexSizes | int32[] | — |
numberOfStartCharacters | int32 | — |
numberOfStopCharacters | int32 | — |
caseSensitive | boolean | — |
textRules | object[] | — |
FilterExpressionProxy
| Property | Type | Default |
|---|---|---|
expression | string | — |
parameters | object | — |
FilterFieldUpdateProxy
| Property | Type | Default |
|---|---|---|
filter | object | — |
fieldName | string | — |
value | any | — |
FilterProxy
| Property | Type | Default |
|---|---|---|
hashString | string | — |
FilterSuggestion
One filter the description asked for: a value (text, or true/false) or a number range, either end open. Field and value are the dataset's own, checked against what it holds.
| Property | Type | Default |
|---|---|---|
field | string | — |
value | string | — |
min | double | — |
max | double | — |
FiltersRequest
| Property | Type | Default |
|---|---|---|
text | string | — |
GroupedSearchRequest
The body of `search/groups`: one text and its settings, split into named sections, each with its own filter, rows and count: a search box's books, authors and events in one call. The members of the search itself are every group's; a group's own filter is ANDed with the search's, and its own candidates, ranking and match replace the search's.
| Property | Type | Default |
|---|---|---|
mode | string | — |
match | object | — |
candidates | object | — |
ranking | object | — |
enableMatchReport | boolean | — |
enableFacets | boolean | false |
facetFields | string[] | — |
facetValueLimit | int32 | 0 |
offset | int32 | 0 |
includeDocuments | boolean | false |
filter | object | — |
filterExpression | string | — |
filterParameters | object | — |
facetSelections | object | — |
facetRanges | object | — |
collapseBy | string[] | — |
counts | object | — |
logPrefix | string | — |
maxNumberOfRecordsToReturn | int32 | 30 |
measureFit | boolean | false |
sortAscending | boolean | false |
sortBy | string | — |
text | string | — |
timeOutLimitMilliseconds | int32 | 1000 |
includeFields | string[] | — |
groups | object[] | — |
HybridQueryProxy
| Property | Type | Default |
|---|---|---|
text | string | — |
maxNumberOfRecordsToReturn | int32 | 10 |
filter | object | — |
filterExpression | string | — |
filterParameters | object | — |
timeOutLimitMilliseconds | int32 | 1000 |
embeddingField | string | — |
vector | float[] | — |
alpha | float | 0.5 |
InFilterProxy
| Property | Type | Default |
|---|---|---|
fieldName | string | — |
values | any[] | — |
isCaseSensitive | boolean | — |
IntentRequest
The text to judge. `Prefetch`: asked while the visitor still types, ahead of the pause; it warms the judge's cache and is not counted as a judgement.
| Property | Type | Default |
|---|---|---|
text | string | — |
prefetch | boolean | — |
JsonNode
| Property | Type | Default |
|---|---|---|
options | object | — |
parent | object | — |
root | object | — |
JsonNodeOptions
| Property | Type | Default |
|---|---|---|
propertyNameCaseInsensitive | boolean | — |
LicenseInfo
| Property | Type | Default |
|---|---|---|
description | string | — |
documentLimit | int32 | — |
documentLimitExceeded | boolean | — |
expirationDate | date-time | — |
licenseFileFound | boolean | — |
licensed | boolean | — |
licensedTo | string | — |
licenseFileName | string | — |
type | string | — |
validLicense | boolean | — |
MatchProxy
| Property | Type | Default |
|---|---|---|
tolerance | string | — |
rungs | string | — |
oneEditFrom | int32 | — |
twoEditsFrom | int32 | — |
threeEditsFrom | int32 | — |
cursorAt | int32 | — |
typingPrefixFrom | int32 | — |
typingPrefixOneEditFrom | int32 | — |
joinedWords | boolean | — |
MultiSearchItem
One search of `search/multi`: a search with its own say in the statistics, over the query string's, so a page can send its visitor's search beside its helper searches in one call and count only the first.
| Property | Type | Default |
|---|---|---|
mode | string | — |
match | object | — |
candidates | object | — |
ranking | object | — |
enableMatchReport | boolean | — |
enableFacets | boolean | false |
facetFields | string[] | — |
facetValueLimit | int32 | 0 |
offset | int32 | 0 |
includeDocuments | boolean | false |
filter | object | — |
filterExpression | string | — |
filterParameters | object | — |
facetSelections | object | — |
facetRanges | object | — |
collapseBy | string[] | — |
counts | object | — |
logPrefix | string | — |
maxNumberOfRecordsToReturn | int32 | 30 |
measureFit | boolean | false |
sortAscending | boolean | false |
sortBy | string | — |
text | string | — |
timeOutLimitMilliseconds | int32 | 1000 |
includeFields | string[] | — |
count | boolean | — |
source | string | — |
session | string | — |
ParseResult
| Property | Type | Default |
|---|---|---|
token | string | — |
progressPercent | int32 | — |
recordIndex | int32 | — |
isEndOfStream | boolean | — |
errorType | string | — |
errorMessage | string | — |
lineNumber | int64 | — |
bytePositionInLine | int64 | — |
jsonPath | string | — |
wasSanitized | boolean | — |
originalToken | string | — |
PositionFilterProxy
| Property | Type | Default |
|---|---|---|
fieldName | string | — |
latitude | float | — |
longitude | float | — |
withinMeter | float | — |
ProblemDetails
| Property | Type | Default |
|---|---|---|
type | string | — |
title | string | — |
status | int32 | — |
detail | string | — |
instance | string | — |
ProcessError
| Property | Type | Default |
|---|---|---|
source | string | — |
message | string | — |
parseError | object | — |
timeStampUtc | date-time | — |
ProcessErrorCount
| Property | Type | Default |
|---|---|---|
error | object | — |
count | int32 | — |
RangeFilterProxy
| Property | Type | Default |
|---|---|---|
fieldName | string | — |
lowerLimit | double | — |
upperLimit | double | — |
RankingProxy
| Property | Type | Default |
|---|---|---|
rerank | boolean | — |
share | float | — |
typingShift | float | — |
longFieldFrom | int32 | — |
longFieldWeightFloor | float | — |
wholeQueryFloor | boolean | — |
fieldWeights | object | — |
fieldBoosts | object | — |
boosts | object[] | — |
buries | object[] | — |
SearchGroup
One section of a IndxServer.Models.GroupedSearchRequest.
| Property | Type | Default |
|---|---|---|
name | string | — |
filter | string | — |
rows | int32 | — |
countFilter | string | — |
candidates | object | — |
ranking | object | — |
match | object | — |
primary | boolean | — |
SearchOrAskSettings
A dataset's Search or ask settings (IndxServer.Services.SearchOrAsk.SearchOrAskStore). Text and numbers only: the request the judge receives has a fixed shape, so an owner, or Observr after a yes, can make the judge better or worse but cannot break the endpoint.
| Property | Type | Default |
|---|---|---|
enabled | boolean | — |
shown | boolean | — |
kind | string | — |
siteDescription | string | — |
titleField | string | — |
sectionFields | string[] | — |
snippetFields | string[] | — |
thresholds | object | — |
mode | string | — |
dailyProactiveAnswers | int32 | — |
strictCoverageWhileAsking | boolean | — |
filtersWhileTyping | string | — |
filterNotes | string | — |
answerInstructions | string | — |
knowledge | string | — |
answerLanguage | string | — |
answers | string | — |
answerModel | string | — |
searches | string | — |
dailyCallBudget | int32 | — |
SearchOrAskThresholds
Where the judge's probability becomes an offer. Entered at one value and left only below a lower one, so the offer does not blink while a visitor types; the client applies that, since it depends on what this visitor has been shown. A value left null is the judge's own (M:IndxServer.Services.SearchOrAsk.SearchOrAskThresholds.For(System.String)), measured for it: switching the judge brings its numbers along, and only what an owner set by hand stays. What a client is sent is always M:IndxServer.Services.SearchOrAsk.SearchOrAskThresholds.Resolved(System.String,System.String), every value a number, since a published intrface spreads these over its defaults and would read a null as 0.
| Property | Type | Default |
|---|---|---|
strong | double | — |
strongHide | double | — |
invite | double | — |
inviteHide | double | — |
hint | double | — |
finished | double | — |
found | double | — |
refocus | double | — |
SelectEventRequest
The select event: the user chose a result. QueryId is the value the search response returned in its `Indx-Query-Id` header; it is optional and opaque — an unknown or expired id still counts on the document, it just finds no search to join. Position is 1-based in the result list. Subject is the optional general identity: a user, a session or a customer-defined segment. Count is false for a select that is not a visitor's (a probe, a test); a select on a search that was not counted is not counted either, whatever it says.
| Property | Type | Default |
|---|---|---|
queryId | string | — |
documentKey | int64 | — |
position | int32 | — |
subject | string | — |
count | boolean | — |
ServerQueryProxy
A search as the server's search routes take it: the library's Indx.Http.QueryProxy, with what only the server does (12 Nov 2026). A subclass, not new members on QueryProxy, because QueryProxy ships in IndxSearchLib and these mean nothing to the library.
| Property | Type | Default |
|---|---|---|
mode | string | — |
match | object | — |
candidates | object | — |
ranking | object | — |
enableMatchReport | boolean | — |
enableFacets | boolean | false |
facetFields | string[] | — |
facetValueLimit | int32 | 0 |
offset | int32 | 0 |
includeDocuments | boolean | false |
filter | object | — |
filterExpression | string | — |
filterParameters | object | — |
facetSelections | object | — |
facetRanges | object | — |
collapseBy | string[] | — |
counts | object | — |
logPrefix | string | — |
maxNumberOfRecordsToReturn | int32 | 30 |
measureFit | boolean | false |
sortAscending | boolean | false |
sortBy | string | — |
text | string | — |
timeOutLimitMilliseconds | int32 | 1000 |
includeFields | string[] | — |
ServerSystemStatus
SystemStatus extended with server-layer fields that the core library has no knowledge of.
| Property | Type | Default |
|---|---|---|
documentCount | int32 | — |
errorMessage | string | — |
invalidArgument | boolean | — |
invalidDataSetName | boolean | — |
invalidState | boolean | — |
licenseInfo | object | — |
recoverableErrors | object[] | — |
searchCounter | int32 | — |
secondsToIndex | double | — |
systemState | string | — |
timeOfInstanceCreation | date-time | — |
timeOfLastIndexBuild | date-time | — |
tooLongSearchText | boolean | — |
indexedTextTruncated | boolean | — |
fieldK1Ignored | boolean | — |
wordTokenSizeCapped | boolean | — |
unrecoverableErrors | object[] | — |
version | string | — |
recordsOnDisk | int32 | — |
fieldsDiscovered | int32 | — |
shadowBuildInProgress | boolean | — |
shadowBuildStartedUtc | date-time | — |
shadowBuildFinishedUtc | date-time | — |
shadowBuildError | string | — |
ShownRequest
| Property | Type | Default |
|---|---|---|
shown | boolean | — |
SortSuggestion
An order the description asked for ("størst", "flest elever"): a Sortable field.
| Property | Type | Default |
|---|---|---|
field | string | — |
descending | boolean | — |
StatisticsSettingsUpdate
A change to the statistics settings (PUT …/statistics/settings). A property left out stays as it is; labelField "" goes back to the first searchable field, timeZone "" to the instance's default.
| Property | Type | Default |
|---|---|---|
recordFilters | boolean | — |
labelField | string | — |
timeZone | string | — |
SynonymEntry
| Property | Type | Default |
|---|---|---|
direction | string | — |
source | string | — |
terms | string[] | — |
SynonymList
| Property | Type | Default |
|---|---|---|
name | string | — |
description | string | — |
updatedUtc | date-time | — |
entries | object[] | — |
TextRule
| Property | Type | Default |
|---|---|---|
from | string | — |
to | string | — |
keepOriginal | boolean | — |
UpdateFieldProxy
| Property | Type | Default |
|---|---|---|
fieldName | string | — |
value | any | — |
UpdateWebhookRequest
The settings an admin may change once a webhook is made.
| Property | Type | Default |
|---|---|---|
name | string | — |
versionField | string | — |
brakeShare | double | — |
settings | object | — |
ValueFilterProxy
| Property | Type | Default |
|---|---|---|
fieldName | string | — |
value | any | — |
isCaseSensitive | boolean | — |
VectorQueryProxy
| Property | Type | Default |
|---|---|---|
fieldName | string | — |
vector | float[] | — |
maxResults | int32 | 10 |
filter | object | — |
filterExpression | string | — |
filterParameters | object | — |