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

KpiService

exabel.api.analytics.v1.KpiService

Service to retrieve KPI results.

Method Name	Request Type	Response Type	Description
ListKpiMappingResults	ListKpiMappingResultsRequest	ListKpiMappingResultsResponse	List KPI mapping results for a single KPI mapping collection.
ListCompanyBaseModelResults	ListCompanyBaseModelResultsRequest	ListCompanyBaseModelResultsResponse	List base model results for a company.
ListCompanyHierarchicalModelResults	ListCompanyHierarchicalModelResultsRequest	ListCompanyHierarchicalModelResultsResponse	List hierarchical model results for a company.
ListCompanyKpiMappingResults	ListCompanyKpiMappingResultsRequest	ListCompanyKpiMappingResultsResponse	List KPI mapping results for a single company KPI.
ListCompanyKpiModelResults	ListCompanyKpiModelResultsRequest	ListCompanyKpiModelResultsResponse	List model results for a single company KPI.

ListKpiMappingResults

List KPI mapping results for a single KPI mapping collection.

Request: ListKpiMappingResultsRequest

Response: ListKpiMappingResultsResponse

ListCompanyBaseModelResults

List base model results for a company.

Request: ListCompanyBaseModelResultsRequest

Response: ListCompanyBaseModelResultsResponse

ListCompanyHierarchicalModelResults

List hierarchical model results for a company.

Request: ListCompanyHierarchicalModelResultsRequest

Response: ListCompanyHierarchicalModelResultsResponse

ListCompanyKpiMappingResults

List KPI mapping results for a single company KPI.

Request: ListCompanyKpiMappingResultsRequest

Response: ListCompanyKpiMappingResultsResponse

ListCompanyKpiModelResults

List model results for a single company KPI.

Request: ListCompanyKpiModelResultsRequest

Response: ListCompanyKpiModelResultsResponse

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. |
| display_name | string | | The human readable name of the signal. |
| 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	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.
downsampling_method	exabel.api.math.Aggregation	The default downsampling method to use when this signal is re-sampled into larger intervals. When two or more values in an interval needs to be aggregated into a single value, specifies how they are combined.
change	exabel.api.math.Change	The method used to calculate changes in this signal.
entity_set	exabel.api.data.v1.EntitySet	The set of entities that this signal is valid for.

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.

Company

exabel.api.analytics.v1.Company

A company.

Field	Type	Description
name	string	The resource name of the company.
display_name	string	The display name of the company.
bloomberg_ticker	string	The bloomberg ticker of the company.

CompanyKpiMappingResults

exabel.api.analytics.v1.CompanyKpiMappingResults

KPI mapping results for a single company.

Field	Type	Label	Description
entity	Company		The company these results apply to.
kpi_results	SingleCompanyKpiMappingResults	repeated	The results for each KPI.

CompanyKpiModelResult

exabel.api.analytics.v1.CompanyKpiModelResult

Result for a single company KPI.

Field	Type	Description
kpi	Kpi	KPI.
model	KpiModel	KPI model.
accessible_mappings_count	int32	Number of KPI mappings for this company KPI that the current user has access to.
total_mappings_count	int32	Total number of KPI mappings for this company KPI, including both accessible KPI mappings and public KPI mappings.
models_count	int32	Number of models for this company KPI.

FiscalPeriodSelector

exabel.api.analytics.v1.FiscalPeriodSelector

Selector for a fiscal period.

Field	Type	Description
relative_selector	RelativeFiscalPeriodSelector	Relative fiscal period.
period_end	exabel.api.time.Date	Specific fiscal period end.
freq	string	Fiscal period frequency. Allowed values are empty, "FQ", "FS" and "FY". Must be set to either "FQ", "FS" or "FY" if `period_end` is specified. If empty, frequency is determined based on KPI counts. The frequency with the most number of KPIs with mappings for the user is used.

Kpi

exabel.api.analytics.v1.Kpi

A KPI.

Field	Type	Label	Description
type	string		The type of the KPI. A KPI is one of the following types: - `FACTSET_ESTIMATES`: FactSet actuals/estimates. - `FACTSET_FUNDAMENTALS`: FactSet fundamentals. - `FACTSET_SEGMENTS`: FactSet segments. - `VISIBLE_ALPHA_STANDARD_KPI`: Visible Alpha standard KPI.
value	string	optional	A value which is dependent on the type: - `FACTSET_ESTIMATES`: Reporting number, e.g. `SALES`. - `FACTSET_FUNDAMENTALS`: Reporting number, e.g. `SALES`. - `FACTSET_SEGMENTS`: Factset segment resource name, e.g. `entityTypes/geo_segment/entities/factset.segment_123`. - `VISIBLE_ALPHA_STANDARD_KPI`: Line item parameter id. For example, the "Total revenue" parameter has a parameter id of `190`.
display_name	string		The display name of the KPI.
freq	string	optional	A textual representation of the KPI frequency. Either `FQ`, `FS` or `FY`.
is_ratio	bool	optional	Whether this KPI is a ratio or not.

KpiBreakdown

exabel.api.analytics.v1.KpiBreakdown

A breakdown of the KPIs.

Field	Type	Label	Description
kpis	KpiBreakdownNode	repeated	The top-level nodes in the breakdown, each of which represents a KPI.

KpiBreakdownNode

exabel.api.analytics.v1.KpiBreakdownNode

A node in the tree representing the breakdown of a KPI.

Field	Type	Label	Description
kpi	Kpi		The KPI represented by this node. Only StructuredKpi is supported, and only the KPI type and the value should be set.
header	string		The string representing this node, when the node represents a grouping of KPIs and not a single one.
children	KpiBreakdownNode	repeated	The children of this node.

KpiHierarchy

exabel.api.analytics.v1.KpiHierarchy

Represents a hierarchy of KPIs for a specific company.

Field	Type	Description
name	string	The resource name of the KPI hierarchy, e.g., "kpiHierarchies/135".
freq	string	The frequency of the KPIs in this hierarchy.
breakdown	KpiBreakdown	A breakdown of the KPIs.

KpiMappingGroup

exabel.api.analytics.v1.KpiMappingGroup

KPI mapping group.

Field	Type	Description
name	string	Resource name.
display_name	string	Display name.
vendor_display_name	string	Vendor display name.

KpiMappingModel

exabel.api.analytics.v1.KpiMappingModel

Single-predictor KPI mapping model.

Field	Type	Label	Description
source	KpiMappingGroup		The KPI mapping group from which the model originates
kpi_model_data	KpiModelData		Model data.

KpiMappingResultData

exabel.api.analytics.v1.KpiMappingResultData

Data for a KPI mapping result.

Field	Type	Label	Description
source	KpiMappingGroup		The KPI mapping group from which this result originates
model_mape	double	optional	Mean absolute percentage error for a model built using this proxy.
model_mae	double	optional	Mean absolute error for a model built using this proxy.
model_hit_rate	double	optional	Hit rate for a model built using this proxy.
last_value_date	exabel.api.time.Date		The date of the last observed proxy value.
number_of_data_points	int32	optional	Number of data points (after resampling). This is the number of data points where both the KPI and the proxy have data.
period_over_period_mae	double	optional	Period-over-period mean absolute error.
year_over_year_mae	double	optional	Year-over-year mean absolute error.
absolute_correlation	double	optional	Absolute correlation.
period_over_period_correlation	double	optional	Period-over-period correlation.
year_over_year_correlation	double	optional	Year-over-year correlation.
absolute_p_value	double	optional	Absolute P-value.
period_over_period_p_value	double	optional	Period-over-period P-value.
year_over_year_p_value	double	optional	Year-over-year P-value.

KpiModel

exabel.api.analytics.v1.KpiModel

A KPI model.

Field	Type	Description
name	string	Resource name.
id	int32	Integer id.
display_name	string	Display name.
data	KpiModelData	Model data.
weights	KpiModelWeightGroups	Model weights.

KpiModelData

exabel.api.analytics.v1.KpiModelData

Data for a KPI model.

Field	Type	Label	Description
prediction	double	optional	Absolute prediction.
prediction_yoy_rel	double	optional	Year-over-year prediction relative change. This is the absolute prediction compared to the observed value for the same period one year ago.
prediction_yoy_abs	double	optional	Year-over-year prediction absolute change. This is the absolute prediction compared to the observed value for the same period one year ago.
consensus	double	optional	Consensus. Only available for Visible Alpha KPIs for users with a subscription with export allowed.
consensus_yoy_rel	double	optional	Year-over-year consensus relative change. This is the consensus compared to the observed value for the same period one year ago.
consensus_yoy_abs	double	optional	Year-over-year consensus absolute change. This is the consensus compared to the observed value for the same period one year ago.
delta_abs	double	optional	Absolute difference between the prediction and the consensus. This is calculated as prediction - consensus. Only available for Visible Alpha KPIs for users with a subscription with export allowed.
delta_rel	double	optional	Relative difference between the prediction and the consensus. This is calculated as (prediction / consensus) - 1. Only available for Visible Alpha KPIs for users with a subscription with export allowed.
delta_by_error	double	optional	The delta divided by the error. For ratio KPIs this is absolute delta / mae (using PiT mae if available). For non-ratio KPIs this is relative delta / mape (using PiT mape if available). Only available for Visible Alpha KPIs for users with a subscription with export allowed.
model_quality	ModelQuality		Model quality.
mape	double	optional	Mean absolute percentage error.
mape_pit	double	optional	Point-in-time mean absolute percentage error.
mae	double	optional	Mean absolute error.
mae_pit	double	optional	Point-in-time mean absolute error.
hit_rate	double	optional	Hit rate.
revision_1_week	double	optional	Revision to the predicted value compared to the prediction from 1 week ago. If the KPI is a ratio, this is just the difference between the current prediction and the prediction from 1 week ago, otherwise this is the relative change. For Exabel Models and custom models, a backtest may be used to get the historical prediction.
revision_1_month	double	optional	Revision to the predicted value compared to the prediction from 1 month ago. If the KPI is a ratio, this is just the difference between the current prediction and the prediction from 1 month ago, otherwise this is the relative change. For Exabel Models and custom models, a backtest may be used to get the historical prediction.
date	exabel.api.time.Date		The fiscal period end date for which the prediction has been made.
error	string		An error message in case the model training or backtesting failed.

KpiModelFeatureWeight

exabel.api.analytics.v1.KpiModelFeatureWeight

Weight for a single KPI model input feature.

Field	Type	Label	Description
weight	double	optional	The weight of the input feature.
display_name	string		Display name of the feature. If there is only a single feature weight, this is identical to the `KpiModelWeightGroup.display_name`. If there are multiple feature weights, this is the display name of the feature. For example, for seasonality, the individual feature weights may include 'Q1', 'Q2', 'Q3', 'Q4' (for the quarter features).

KpiModelWeightGroup

exabel.api.analytics.v1.KpiModelWeightGroup

Weight for a group of related KPI model input features.

Field	Type	Label	Description
display_name	string		Display name of the model input feature/predictor. For ratio prediction models, this is either 'Baseline' (representing the predictor built by forecasting the KPI time series) or it is the display name of the KPI mapping group from which the predictor originates. For other model types, display names include 'Seasonality' and 'Reported KPI (lagged)'.
group	KpiMappingGroup		The KPI mapping group from which the predictor originates. Only set when the predictor originates from a KPI mapping group.
feature_weights	KpiModelFeatureWeight	repeated	The individual feature weights.

KpiModelWeightGroups

exabel.api.analytics.v1.KpiModelWeightGroups

KPI model weight groups.

Field	Type	Label	Description
weight_groups	KpiModelWeightGroup	repeated	Weights for all predictors in the model.
is_coefficients	bool		Whether the weights are coefficients that should be formatted as decimal numbers. If false, the weights are normalized weights that add up to 1.

SingleCompanyKpiMappingResults

exabel.api.analytics.v1.SingleCompanyKpiMappingResults

KPI mapping results for a single company KPI.

Field	Type	Label	Description
kpi	Kpi		The KPI.
data	KpiMappingResultData	repeated	The KPI mapping results for this KPI.

KpiSource

KPI source.

Name	Number	Description
KPI_SOURCE_UNSPECIFIED	0	Unspecified.
KPI_SOURCE_VISIBLE_ALPHA	1	Visible Alpha.
KPI_SOURCE_FACTSET	2	FactSet.

ModelQuality

Model quality.

Name	Number	Description
MODEL_QUALITY_UNSPECIFIED	0	Unspecified.
MODEL_QUALITY_LOW	10	Low quality.
MODEL_QUALITY_MEDIUM	20	Medium quality.
MODEL_QUALITY_HIGH	30	High quality.
MODEL_QUALITY_VERY_HIGH	40	Very high quality.

RelativeFiscalPeriodSelector

Selector for a relative fiscal period.

Name	Number	Description
RELATIVE_FISCAL_PERIOD_SELECTOR_UNSPECIFIED	0	Unspecified.
PREVIOUS	1	Last reported fiscal period.
CURRENT	2	Current unreported fiscal period.
NEXT	3	Next unreported fiscal period.

ListCompanyBaseModelResultsRequest

exabel.api.analytics.v1.ListCompanyBaseModelResultsRequest

Request to ListCompanyBaseModelResults.

Field	Type	Description
parent	string	Resource name of the company get results for.
period	FiscalPeriodSelector	The fiscal period and frequency to get results for. If not specified, `RelativeFiscalPeriodSelector.CURRENT` is used and frequency is determined based on KPI counts. The frequency with the most number of KPIs with mappings for the user is used.
kpi_source	KpiSource	Optional KPI source. If not specified, all KPIs are returned.

ListCompanyBaseModelResultsResponse

exabel.api.analytics.v1.ListCompanyBaseModelResultsResponse

Response from ListCompanyBaseModelResults.

Field	Type	Label	Description
results	CompanyKpiModelResult	repeated	List of results.

ListCompanyHierarchicalModelResultsRequest

exabel.api.analytics.v1.ListCompanyHierarchicalModelResultsRequest

Request to ListCompanyHierarchicalModelResults.

Field	Type	Description
parent	string	Resource name of the company get results for.
period	FiscalPeriodSelector	The fiscal period and frequency to get results for. If not specified, `RelativeFiscalPeriodSelector.CURRENT` is used and frequency is determined based on KPI counts. The frequency with the most number of KPIs with mappings for the user is used.
kpi_source	KpiSource	Optional KPI source. If not specified, all KPIs are returned.

ListCompanyHierarchicalModelResultsResponse

exabel.api.analytics.v1.ListCompanyHierarchicalModelResultsResponse

Response from ListCompanyHierarchicalModelResults.

Field	Type	Label	Description
results	CompanyKpiModelResult	repeated	List of results.
kpi_hierarchy	KpiHierarchy		The KPI hierarchy for the company.

ListCompanyKpiMappingResultsRequest

exabel.api.analytics.v1.ListCompanyKpiMappingResultsRequest

Request to ListCompanyKpiMappingResults.

Field	Type	Label	Description
parent	string		Resource name of the company to get KPI mapping results for.
kpi	Kpi		KPI to get KPI mapping results for. The fields `type`, `value` and `freq` must be specified.

ListCompanyKpiMappingResultsResponse

exabel.api.analytics.v1.ListCompanyKpiMappingResultsResponse

Response from ListCompanyKpiMappingResults.

Field	Type	Label	Description
results	KpiMappingResultData	repeated	KPI mapping results.

ListCompanyKpiModelResultsRequest

exabel.api.analytics.v1.ListCompanyKpiModelResultsRequest

Request to ListCompanyKpiModelResults.

Field	Type	Label	Description
parent	string		Resource name of the company to get model results for.
kpi	Kpi		KPI to get model results for. The fields `type`, `value` and `freq` must be specified.

ListCompanyKpiModelResultsResponse

exabel.api.analytics.v1.ListCompanyKpiModelResultsResponse

Response from ListCompanyKpiModelResults.

Field	Type	Label	Description
exabel_model	KpiModel		Exabel model.
hierarchical_model	KpiModel		Hierarchical model.
custom_models	KpiModel	repeated	Custom models.
kpi_mapping_models	KpiMappingModel	repeated	Single-predictor KPI mapping models.

ListKpiMappingResultsRequest

exabel.api.analytics.v1.ListKpiMappingResultsRequest

Request to ListKpiMappingResults.

Field	Type	Description
parent	string	Resource name of the KPI mapping to list results of. Example: `kpiMappings/123`.
page_size	int32	Maximum number of companies to return. Defaults to 20, and the maximum allowed value is 100.
page_token	string	Token for a specific page of results, as returned from a previous list request with the same query parameters.

ListKpiMappingResultsResponse

exabel.api.analytics.v1.ListKpiMappingResultsResponse

Response from ListKpiMappingResults.

Field	Type	Label	Description
results	CompanyKpiMappingResults	repeated	List of results, one for each company. The end of the list is reached when the token is empty.
next_page_token	string		Token for the next page of results, which can be sent to a subsequent list query.
total_size	int32		Total number of rows, irrespective of paging.

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	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.

AddEntitiesRequest

exabel.api.analytics.v1.AddEntitiesRequest

Request to add entities to tag.

Field	Type	Label	Description
name	string		Resource name of the tag to add entities to Example: `tags/user:abc123`.
entity_names	string	repeated	List of entity resource names to add to tag. You may find these resource names with the EntityService.

AddEntitiesResponse

exabel.api.analytics.v1.AddEntitiesResponse

Response to add entities to a tag

No fields

CreateTagRequest

exabel.api.analytics.v1.CreateTagRequest

Request to CreateTag.

Field	Type	Label	Description
tag	Tag		A tag
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.

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	Description
parent	string	The parent tag to list entities for Example: `tags/user:abc123`.
page_size	int32	Maximum number of entities 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.

Field	Type	Label	Description
entity_names	string	repeated	List of entity resource names.
next_page_token	string		Token for the next page of results, which can be sent to a subsequent query. The end of the list is reached when the token is empty.
total_size	int32		Total number of results, irrespective of paging.

ListTagsRequest

exabel.api.analytics.v1.ListTagsRequest

Request to list tags.

Field	Type	Label	Description
page_size	int32		Maximum number of tags 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.

ListTagsResponse

exabel.api.analytics.v1.ListTagsResponse

Response to list tags.

Field	Type	Label	Description
tags	Tag	repeated	The tags in the requested page.
next_page_token	string		Token for the next page of results, which can be sent to a subsequent query. The end of the list is reached when the token is empty.
total_size	int32		Total number of results, irrespective of paging.

RemoveEntitiesRequest

exabel.api.analytics.v1.RemoveEntitiesRequest

Request to remove entities from a tag.

Field	Type	Label	Description
name	string		Resource name of the tag to remove entities from Example: `tags/user:abc123`.
entity_names	string	repeated	List of entity resource names to remove from 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. |