This is a lower-level API. Lower-level APIs are not recommended for most projects, and may not be available on all plans. See our page on recommended deployment patterns for more information.
Public Method Question Editor API

getMetadata()

Returns the metadata JSON of the current widget.

Currently metadata has key template_reference which specifies the template with which the current question is displayed. If a question is displayed within a custom template, the metadata should be saved as part of the question. On editing the question, setWidget should be called with the metadata as second argument, so that the question is displayed as it was at creation time.

Arguments

None.

Return value

Value object

A return object of getMetadata that contains template name and template_reference data

Properties
name
 string

Template name of given question/feature
template_reference
 string

Template reference of given question/feature
created_through
 string

Indicates how this question was created (e.g. via generative ai)
translated_through
 string

Indicates how this question was translated (e.g. via generative ai)
Was this article helpful?