calculated_channels - Sift

Services

RPC methods exposed by this API.

CalculatedChannelsService

Method	Request	Response	Description
ListExpressionIdentifiers	ListExpressionIdentifiersRequest	ListExpressionIdentifiersResponse	Retrieves a list of valid identifiers that can be used as part of a calculated channel expression.
ValidateExpression	ValidateExpressionRequest	ValidateExpressionResponse	Used to validate whether or not an expression used for a calculated channel is valid.

Messages

Data models used across requests/responses.

ErrorValidatingExpressionResult

Field	Type	Label	Description
error_message	string

ExpressionChannelReference

Field	Type	Label	Description
channel_reference	string
channel_id	string
oneof calculated_channel_reference. calculated_channel	ExpressionRequest

ExpressionIdentifier

Field	Type	Label	Description
name	string
description	string
type	ExpressionIdentifierType
display_name	string
library	ExpressionIdentifierLibrary

ExpressionRequest

Field	Type	Label	Description
channel_references	ExpressionRequest.ChannelReferencesEntry	repeated	Deprecated. A map from the channel reference in the expression string (e.g. $1) to the channel id (uuid). This is deprecated and should be passed in expression_channel_references instead.
expression	string
expression_channel_references	ExpressionChannelReference	repeated
function_dependencies	sift.common.type.v1.FunctionDependency	repeated

ExpressionRequest.ChannelReferencesEntry

Field	Type	Label	Description
key	string
value	string

ListExpressionIdentifiersRequest

Field	Type	Label	Description
page_size	uint32		Defaults to 1000. Max of 10,000.
page_token	string
mode	ExpressionMode

ListExpressionIdentifiersResponse

Field	Type	Label	Description
identifiers	ExpressionIdentifier	repeated
next_page_token	string	optional

SuccessValidatingExpressionResult

Field	Type	Label	Description
data_type	sift.common.type.v1.ChannelDataType

ValidateExpressionRequest

Field	Type	Label	Description
expression	ExpressionRequest
mode	ExpressionMode

ValidateExpressionResponse

Field	Type	Label	Description
oneof result. error	ErrorValidatingExpressionResult
oneof result. success	SuccessValidatingExpressionResult

Enums

Allowed constant values used in message fields.

ExpressionIdentifierLibrary

Name	Number	Description
EXPRESSION_IDENTIFIER_LIBRARY_UNSPECIFIED	0
EXPRESSION_IDENTIFIER_LIBRARY_MATH	1
EXPRESSION_IDENTIFIER_LIBRARY_STRING	2
EXPRESSION_IDENTIFIER_LIBRARY_LIST	3
EXPRESSION_IDENTIFIER_LIBRARY_ITER	4
EXPRESSION_IDENTIFIER_LIBRARY_STATEFUL	5
EXPRESSION_IDENTIFIER_LIBRARY_SUMMARY	6
EXPRESSION_IDENTIFIER_LIBRARY_USER_DEFINED_FUNCTIONS	7

ExpressionIdentifierType

Name	Number	Description
EXPRESSION_IDENTIFIER_TYPE_UNSPECIFIED	0	Deprecated.
EXPRESSION_IDENTIFIER_TYPE_FUNCTION	1
EXPRESSION_IDENTIFIER_TYPE_CHANNEL	2

ExpressionMode

Name	Number	Description
EXPRESSION_MODE_UNSPECIFIED	0	Deprecated.
EXPRESSION_MODE_RULES	1
EXPRESSION_MODE_CALCULATED_CHANNELS	2
EXPRESSION_MODE_RULER	3
EXPRESSION_MODE_STRUCTURED_DATA	4

⌘I