Document Entry Object


A Wix documentation entry returned as a search result.

Properties
contentstringmaxLength 100000

The full text content of the documentation entry.


examplesArray <DocumentExample>maxItems 100

Authored request examples found in this result's indexed content. Set only on method results whose documentation embeds titled examples. The list may be a subset of the method's examples when the result is a content chunk. Retrieve a complete example by reading the full article at url and locating the example with the exact title.


idstringmaxLength 500

The unique identifier for this documentation entry.


kbNamestringmaxLength 100

The knowledge base this entry was retrieved from (e.g. "REST_METHODS_KB_ID").


relevanceScorefloat

The relevance score in the range [0, 1]. Higher means more relevant.


titlestringmaxLength 1000

The title of the documentation entry.


updatedDatestringformat date-time

The date the document was last updated.


urlstringmaxLength 2000

The direct URL to the documentation page for this entry.

Did this help?