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.
Derived signals are stored in Library folders and shared across users through folder sharing.
Requests to the DerivedSignalService are executed in the context of the customer's service
account (SA). The SA is a special user that is a member of the customer user group, giving
it access to all folders that are shared with this user group, but not to private folders.
Hence, only derived signals that are in folders shared to the SA, via the customer user group,
will be accessible via the DerivedSignalService.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| GetDerivedSignal | GetDerivedSignalRequest | DerivedSignal | Gets a derived signal. |
| CreateDerivedSignal | CreateDerivedSignalRequest | DerivedSignal | Creates a derived signal. |
| UpdateDerivedSignal | UpdateDerivedSignalRequest | DerivedSignal | Updates a derived signal. |
| DeleteDerivedSignal | DeleteDerivedSignalRequest | .google.protobuf.Empty | Deletes a derived signal. |
GetDerivedSignal
Gets a derived signal.
The derived signal must be in a folder that is shared to your service account (which is always
in your main customer user group).
Request: GetDerivedSignalRequest
Response: DerivedSignal
CreateDerivedSignal
Creates a derived signal.
Request: CreateDerivedSignalRequest
Response: DerivedSignal
UpdateDerivedSignal
Updates a derived signal.
Note that this method will update all fields unless update_mask is set.
Request: UpdateDerivedSignalRequest
Response: DerivedSignal
DeleteDerivedSignal
Deletes 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.
Requests to the PredictionModelService are executed in the context of the customer's service
account (SA). The SA is a special user that is a member of the customer user group, giving
it access to all folders that are shared with this user group, but not to private folders.
Hence, only prediction models that are in folders shared to the SA, via the customer user group,
will be accessible via the PredictionModelService.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| CreatePredictionModelRun | CreatePredictionModelRunRequest | PredictionModelRun | Runs a prediction model. |
CreatePredictionModelRun
Runs a prediction model.
Request: CreatePredictionModelRunRequest
Response: PredictionModelRun
TagService
exabel.api.analytics.v1.TagService
Service for managing tags. See the User Guide for more information about tags:
https://help.exabel.com/docs/tags-screens
Requests to the TagService are executed in the context of the customer's service account (SA).
The SA is a special user that is a member of the customer user group, giving it access to all
folders that are shared with this user group, but not to private folders.
Hence, only tags that are in folders shared to the SA, via the customer user group,
will be accessible via the TagService.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| CreateTag | CreateTagRequest | Tag | Create a tag. |
| GetTag | GetTagRequest | Tag | Get a tag. |
| UpdateTag | UpdateTagRequest | Tag | Update a tag. |
| DeleteTag | DeleteTagRequest | .google.protobuf.Empty | Delete a tag. |
| ListTags | ListTagsRequest | ListTagsResponse | List all tags accessible by the user. |
| AddEntities | AddEntitiesRequest | AddEntitiesResponse | Add entities to a tag. Entities that exist in the tag already will be ignored |
| RemoveEntities | RemoveEntitiesRequest | RemoveEntitiesResponse | Remove a set of entities from tag. |
| ListTagEntities | ListTagEntitiesRequest | ListTagEntitiesResponse | List all entities in a tag. |
CreateTag
Create a tag.
Request: CreateTagRequest
Response: Tag
GetTag
Get a tag.
Request: GetTagRequest
Response: Tag
UpdateTag
Update a tag.
Note that this method will update all fields unless update_mask is set.
Request: UpdateTagRequest
Response: Tag
DeleteTag
Delete a tag.
Request: DeleteTagRequest
Response: .google.protobuf.Empty
ListTags
List all tags accessible by the user.
Request: ListTagsRequest
Response: ListTagsResponse
AddEntities
Add entities to a tag. Entities that exist in the tag already will be ignored
Entities that exist in the tag already will be ignored.
Request: AddEntitiesRequest
Response: AddEntitiesResponse
RemoveEntities
Remove a set of entities from tag.
Request: RemoveEntitiesRequest
Response: RemoveEntitiesResponse
ListTagEntities
List all entities in a tag.
Request: ListTagEntitiesRequest
Response: ListTagEntitiesResponse
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.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | Unique resource name of the derived signal, e.g. derivedSignals/123. In the "Create derived signal" method, this is ignored and may be left empty. | |
| label | 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. |
| expression | string | | A DSL expression describing the signal transformations to apply. For more information, see the DSL reference. |
| description | string | | Appears in the Exabel Library, when browsing for derived signals. |
| metadata | DerivedSignalMetadata | | Additional metadata to control formatting (decimals and units). |
DerivedSignalMetadata
exabel.api.analytics.v1.DerivedSignalMetadata
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.
| Field | Type | Label | Description |
|---|---|---|---|
| decimals | google.protobuf.Int32Value | Number of decimals to use when displaying numeric values. | |
| unit | DerivedSignalUnit | Unit of the signal. | |
| type | DerivedSignalType | Type of the signal. Not relevant for external use. |
DerivedSignalType
Type of the signal. Not relevant for external use.
| Name | Number | Description |
|---|---|---|
| DERIVED_SIGNAL_TYPE_INVALID | 0 | Signal type was not specified. |
| DERIVED_SIGNAL | 1 | Signal is a derived signal, with an editable label and expression. This is the default value. |
| FILE_UPLOADED_SIGNAL | 2 | Signal uploaded through the legacy File Uploader. The expression refers to a raw signal and cannot be modified. |
| FILE_UPLOADED_COMPANY_SIGNAL | 3 | Signal uploaded through the legacy File Uploader. The expression refers to a raw signal and cannot be modified. |
| PERSISTED_SIGNAL | 4 | A persisted signal that is evaluated and cached daily. The expression refers to a raw signal and cannot be modified. |
DerivedSignalUnit
Unit of the signal.
| Name | Number | Description |
|---|---|---|
| DERIVED_SIGNAL_UNIT_INVALID | 0 | Signal unit was not specified. |
| NUMBER | 1 | Signal represents normal floating point numbers. This is the default value. |
| RATIO | 2 | Signal represents a ratio, typically with values in the interval [0, 1]. Values will be displayed as a percentage. |
| RATIO_DIFFERENCE | 3 | Signal represents a difference in a ratio. Values will be displayed as percentage points. |
CreateDerivedSignalRequest
exabel.api.analytics.v1.CreateDerivedSignalRequest
Request to CreateDerivedSignal.
| Field | Type | Label | Description |
|---|---|---|---|
| signal | DerivedSignal | A derived signal. | |
| folder | string | Resource name of the Library folder to create the signal in, e.g. folders/123. If not specified, the signal will be created in an “Analytics API” folder that is shared with the customer user group. |
DeleteDerivedSignalRequest
exabel.api.analytics.v1.DeleteDerivedSignalRequest
Request to DeleteDerivedSignal.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | The derived signal resource name. |
GetDerivedSignalRequest
exabel.api.analytics.v1.GetDerivedSignalRequest
Request to GetDerivedSignal.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | The derived signal resource name. |
UpdateDerivedSignalRequest
exabel.api.analytics.v1.UpdateDerivedSignalRequest
Request to UpdateDerivedSignal.
| Field | Type | Label | Description |
|---|---|---|---|
| signal | DerivedSignal | A derived signal. | |
| update_mask | google.protobuf.FieldMask | 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. |
ItemMetadata
exabel.api.analytics.v1.ItemMetadata
Metadata about an item.
| Field | Type | Label | Description |
|---|---|---|---|
| create_time | google.protobuf.Timestamp | When the item was created. | |
| update_time | google.protobuf.Timestamp | When the item was last updated. | |
| created_by | string | Resource name of the user who created the item. | |
| updated_by | string | Resource name of the user who last updated the item. | |
| write_access | bool | optional | Whether the API caller has write access to the item. May not always be populated. |
PredictionModelRun
exabel.api.analytics.v1.PredictionModelRun
A prediction model run.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | Unique resource name of the run, e.g. predictionModels/123/runs/3. | |
| description | string | You may use this to record some notes about the run. This is shown in the prediction model interface when viewing all runs, and when viewing the results of a single run. | |
| configuration | ModelConfiguration | Which model configuration to use. If not specified, the latest model configuration is used. Note that the current signal library is always loaded. | |
| configuration_source | int32 | optional | Prediction model run number from which model configuration should be retrieved, e.g. 1. Only relevant when configuration is set to ModelConfiguration.SPECIFIC_RUN. |
| auto_activate | bool | Whether to automatically set this run as active once it completes. The run will not be activated if it fails for any of the entities in the model. |
ModelConfiguration
Specifies which model configuration to use. If not specified, the latest model configuration is used.
Note that the current signal library is always loaded.
| Name | Number | Description |
|---|---|---|
| MODEL_CONFIGURATION_NOT_SPECIFIED | 0 | Not specified - defaults to use the latest configuration. |
| LATEST | 1 | Latest configuration. |
| ACTIVE | 2 | Configuration of the active run. A specific run may be activated from the prediction model user interface. |
| SPECIFIC_RUN | 3 | Configuration of a specific run. The run number must be specified as well. |
CreatePredictionModelRunRequest
exabel.api.analytics.v1.CreatePredictionModelRunRequest
Request to CreatePredictionModelRun.
| Field | Type | Label | Description |
|---|---|---|---|
| parent | string | Resource name of the prediction model for which the run should be created. Example: predictionModels/123. | |
| run | PredictionModelRun | The model run. |
Tag
exabel.api.analytics.v1.Tag
Represents a tag.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | Unique resource name of the tag, e.g. tags/user:806f697b-e9fa-4443-9f92-ba46e5b60930. | |
| display_name | string | Display name of the tag. This is shown wherever the tag is used in the Exabel app. | |
| description | string | You may use this to provide more information about the tag. This is shown in the Library when browsing for tags. | |
| entity_type | string | Resource name of the tag's entity type. |
Tags can only contain entities of one entity type. For new tags, this is set once the first entity is added. |
| metadata | ItemMetadata | | Metadata about the tag. |
AddEntitiesRequest
exabel.api.analytics.v1.AddEntitiesRequest
Request to add entities to tag.
AddEntitiesResponse
exabel.api.analytics.v1.AddEntitiesResponse
Response to add entities to a tag
No fields
CreateTagRequest
exabel.api.analytics.v1.CreateTagRequest
Request to CreateTag.
DeleteTagRequest
exabel.api.analytics.v1.DeleteTagRequest
Request to DeleteTag.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | The tag resource name. |
GetTagRequest
exabel.api.analytics.v1.GetTagRequest
Request to GetTag.
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | Resource name of the requested tag Example: tags/user:abc123. |
ListTagEntitiesRequest
exabel.api.analytics.v1.ListTagEntitiesRequest
Request to list entities in a tag.
| Field | Type | Label | Description |
|---|---|---|---|
| parent | string | The parent tag to list entities for Example: tags/user:abc123. | |
| page_size | int32 | Maximum number of results to return. Default is 20 and max is 1000. | |
| page_token | string | Token for a specific page of results, as returned from a previous list request with the same query parameters. |
ListTagEntitiesResponse
exabel.api.analytics.v1.ListTagEntitiesResponse
Response to list entities in a tag.
ListTagsRequest
exabel.api.analytics.v1.ListTagsRequest
Request to list tags.
ListTagsResponse
exabel.api.analytics.v1.ListTagsResponse
Response to list tags.
RemoveEntitiesRequest
exabel.api.analytics.v1.RemoveEntitiesRequest
Request to remove entities from a tag.
RemoveEntitiesResponse
exabel.api.analytics.v1.RemoveEntitiesResponse
Response to remove entities from a tag
No fields
UpdateTagRequest
exabel.api.analytics.v1.UpdateTagRequest
Request to UpdateTag.
| Field | Type | Label | Description |
|---|---|---|---|
| tag | Tag | A tag. | |
| update_mask | google.protobuf.FieldMask | Use this to update only selected fields. For example, specify display_name to update only the display name. |
For REST requests, this is a comma-separated string. |
Updated over 1 year ago