User GuideAPI ReferenceWhat's NewChangelog
API Reference

Update derived signal

patch
https://analytics.api.exabel.com/v1/derivedSignals/

Note that this method will update all fields unless updateMask is set.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The ID of a derived signal, e.g. 123.

Query Params
string

Use this to update only selected fields. For example, specify expression to update only the expression.

For REST requests, this is a comma-separated string.

Body Params

A derived signal.

string

Label of the derived signal. This appears in the Library when browsing for derived signals, and when a derived signal is used in any Exabel feature (e.g. chart, dashboard). It can also be used to reference this derived signal in a second derived signal.

This is required when creating a derived signal. Must be a valid Python identifier between 1-100 characters, match the regex ^[a-zA-Z_]\w{0,99}$, and cannot be a Python keyword.

string

A DSL expression describing the signal transformations to apply. For more information, see the DSL reference.

string

Appears in the Exabel Library, when browsing for derived signals.

string

The human readable name of the signal.

metadata
object

Additional metadata to control formatting (decimals and units).

Note: this is only used today when a signal is added to a dashboard table. This will be phased out in favour of providing formatting controls in the Exabel features (charts, dashboards, etc.) where signals are used.

Responses

Updated 4 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago