Analytics API gRPC reference

Services

DerivedSignalService

exabel.api.analytics.v1.DerivedSignalService

Service to manage derived signals.

A derived signal is a DSL expression with a unique label. The label must be unique to the
customer.

GetDerivedSignal

Get a derived signal.

Request: GetDerivedSignalRequest

Response: DerivedSignal

CreateDerivedSignal

Create a derived signal.

Request: CreateDerivedSignalRequest

Response: DerivedSignal

UpdateDerivedSignal

Update a derived signal.

Request: UpdateDerivedSignalRequest

Response: DerivedSignal

DeleteDerivedSignal

Delete a derived signal.

Request: DeleteDerivedSignalRequest

Response: .google.protobuf.Empty

PredictionModelService

exabel.api.analytics.v1.PredictionModelService

Service to manage prediction models.

The only current supported operation is to request to run a given prediction model.

Method NameRequest TypeResponse TypeDescription
CreatePredictionModelRunCreatePredictionModelRunRequestPredictionModelRunCreate a model run.

CreatePredictionModelRun

Create a model run.

Request: CreatePredictionModelRunRequest

Response: PredictionModelRun

Messages

DerivedSignal

exabel.api.analytics.v1.DerivedSignal

A derived signal.

As opposed to raw signals which represents time series on entities, a derived signal
represents a calculation through a DSL expression.

FieldTypeLabelDescription
namestringThe resource name. Example: derivedSignals/123. These resource names are not namespaced, andthe identifier is always an integer. It is required in all operations except the createoperation, where it is ignored.
labelstringThe label. Cannot be empty, and therefore required when creating derived signal. Can be usedto refer to this signal in other expressions. Must be a valid Python identifier of maximum100 characters, i.e. match the regex ^[a-zA-Z_]\w{0,99}$ and not to equal any Python keyword.
expressionstringThe expression. A DSL expression.
descriptionstringThe description.
metadataDerivedSignalMetadataAdditional signal metadata.

DerivedSignalMetadata

exabel.api.analytics.v1.DerivedSignalMetadata

The metadata of a derived signal.

FieldTypeLabelDescription
decimalsgoogle.protobuf.Int32ValueThe number of decimals to use when displaying signal values.
unitDerivedSignalUnitThe unit of the signal.
typeDerivedSignalTypeThe type of the signal. Output only.

DerivedSignalType

Enum representing the type of a signal.

NameNumberDescription
DERIVED_SIGNAL_TYPE_INVALID0The signal type was not specified.
DERIVED_SIGNAL1The signal is a normal derived signal, represented by an editable expression and label. Thisis the default value.
FILE_UPLOADED_SIGNAL2A signal time series uploaded through the app's file upload.The expression refers to a raw signal and cannot be modified.
FILE_UPLOADED_COMPANY_SIGNAL3A signal company time series uploaded through the app's file upload.The expression refers to a raw signal and cannot be modified.
PERSISTED_SIGNAL4A persisted signal.The expression refers to a raw signal and cannot be modified.

DerivedSignalUnit

Enum representing the unit of a signal.

NameNumberDescription
DERIVED_SIGNAL_UNIT_INVALID0The signal unit was not specified.
NUMBER1The signal represents normal floating point numbers. This is the default value.
RATIO2The signal represents a ratio, typically with values in the interval [0, 1].Values will be displayed as a percentage.
RATIO_DIFFERENCE3The signal represents a difference in a ratio. Values will be displayedas percentage points.

CreateDerivedSignalRequest

exabel.api.analytics.v1.CreateDerivedSignalRequest

Request to CreateDerivedSignal.

FieldTypeLabelDescription
signalDerivedSignalA derived signal.
folderstringThe resource name of the folder to put the signal in. Example: folder/123.If this is not provided, the signal will be put in the default analytics API folder.

DeleteDerivedSignalRequest

exabel.api.analytics.v1.DeleteDerivedSignalRequest

Request to DeleteDerivedSignal.

FieldTypeLabelDescription
namestringThe derived signal resource name.

GetDerivedSignalRequest

exabel.api.analytics.v1.GetDerivedSignalRequest

Request to GetDerivedSignal.

FieldTypeLabelDescription
namestringThe derived signal resource name.

UpdateDerivedSignalRequest

exabel.api.analytics.v1.UpdateDerivedSignalRequest

Request to UpdateDerivedSignal.

FieldTypeLabelDescription
signalDerivedSignalA derived signal.
update_maskgoogle.protobuf.FieldMaskThe update mask to apply to the resource. If present, only the fields mentioned in this maskwill be modified.

PredictionModelRun

exabel.api.analytics.v1.PredictionModelRun

A prediction model run.

FieldTypeLabelDescription
namestringResource name of the run. Example: predictionModels/123/runs/3.
descriptionstringAn optional description of the run.

CreatePredictionModelRunRequest

exabel.api.analytics.v1.CreatePredictionModelRunRequest

Request to CreatePredictionModelRun.

FieldTypeLabelDescription
parentstringResource name of the prediction model for which the run should be created.Example: predictionModels/123.
runPredictionModelRunThe model run.