Messages
Data models used across requests/responses.AnnotationActionConfiguration
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| tag_ids | string | repeated | |
| annotation_type | sift.annotations.v1.AnnotationType | ||
| assigned_to_user_id | string | optional | |
| metadata | sift.metadata.v1.MetadataValue | repeated |
ArchiveRuleRequest
ArchiveRuleRequest is used to archive a rule by rule_id or client_key. If both are provided, only rule_id will be used.ArchiveRuleResponse
No description provided. This message has no fields.AssetExpressionValidationResult
No description provided.BatchArchiveRulesRequest
BatchArchiveRulesRequest is used to archive a rule by rule_id or client_key. For each rule if both are provided, only rule_id will be used.BatchArchiveRulesResponse
No description provided. This message has no fields.BatchDeleteRulesRequest
BatchDeleteRulesRequest is used to delete a rule by rule_id or client_key. For each rule if both are provided, only rule_id will be used.BatchDeleteRulesResponse
No description provided. This message has no fields.BatchGetRuleVersionsRequest
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rule_version_ids | string | repeated |
BatchGetRuleVersionsResponse
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rules | Rule | repeated |
BatchGetRulesRequest
BatchGetRulesRequest is used to retrieve rules by rule_ids or client_keys. If both are provided, both will be used to retrieve rules.BatchGetRulesResponse
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rules | Rule | repeated |
BatchUnarchiveRulesRequest
BatchUnarchiveRulesRequest is used to unarchive a rule by rule_id or client_key. For each rule if both are provided, only rule_id will be used.BatchUnarchiveRulesResponse
No description provided. This message has no fields.BatchUndeleteRulesRequest
BatchUndeleteRulesRequest is used to delete a rule by rule_id or client_key. For each rule if both are provided, only rule_id will be used.BatchUndeleteRulesResponse
No description provided. This message has no fields.BatchUpdateRulesRequest
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rules | UpdateRuleRequest | repeated | rules are limited 1000 rules at a time |
| validate_only | bool | If validate_only is true, the request will only validate the request and not save the rules. | |
| override_expression_validation | bool | If override_expression_validation is true, the request will save the rules even if the expressions are invalid. This can be useful for multi-asset rules where an invalid expression for one asset should not prevent the rule from being saved. |
BatchUpdateRulesResponse
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| success | bool | ||
| rules_created_count | int32 | The total number of rules created in the request. If validate_only is true, this will indicate how many rules would have been created. | |
| rules_updated_count | int32 | The total number of rules updated in the request. If validate_only is true, this will indicate how many rules would have been updated. | |
| validate_only | bool | This will be true if the request only validated the request and did not save the rules. | |
| validation_results | ValidationResult | repeated | One ValidationResult per rule in the request will be returned |
| created_rule_identifiers | BatchUpdateRulesResponse.RuleIdentifiers | repeated | The created rule id, name, version, and client key. |
BatchUpdateRulesResponse.RuleIdentifiers
No description provided.CalculatedChannelConfig
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| channel_references | CalculatedChannelConfig.ChannelReferencesEntry | repeated | |
| expression | string | ||
| function_dependencies | sift.common.type.v1.FunctionDependency | repeated | This will be ignored in requests and will be generated automatically. |
CalculatedChannelConfig.ChannelReferencesEntry
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | ChannelReference |
ChannelReference
No description provided.ContextualChannels
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| channels | ChannelReference | repeated |
CreateRuleRequest
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| update | UpdateRuleRequest |
CreateRuleResponse
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rule_id | string |
DeleteRuleRequest
DeleteRuleRequest is used to delete a rule by rule_id or client_key. If both are provided, only rule_id will be used.DeleteRuleResponse
No description provided. This message has no fields.DryRunAnnotation
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| condition_id | string | ||
| name | string | ||
| start_time | google.protobuf.Timestamp | ||
| end_time | google.protobuf.Timestamp | ||
| condition_version_id | string |
EvaluateRulesRequest
Deprecated - use RuleEvaluationService instead.| Field | Type | Label | Description |
|---|---|---|---|
| rule_ids | string | repeated | |
| annotation_options | EvaluatedAnnotationOptions | ||
| oneof time. run_id | string | ||
| oneof time. time_range | TimeRangeQuery | ||
| dry_run | bool |
EvaluateRulesResponse
Deprecated - use RuleEvaluationService instead.| Field | Type | Label | Description |
|---|---|---|---|
| created_annotation_count | int32 | ||
| dry_run_annotations | DryRunAnnotation | repeated | If dry_run is true, this will be populated with the annotations that would be created |
| job_id | string | optional | job_id and report_id will be set if the job has an extended run time and is being processed asynchronously. |
| report_id | string | optional |
EvaluatedAnnotationOptions
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| tag_ids | string | repeated |
GetRuleRequest
GetRuleRequest is used to retrieve a rule by rule_id or client_key. If both are provided, only rule_id will be used.GetRuleResponse
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rule | Rule |
GetRuleVersionRequest
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rule_version_id | string |
GetRuleVersionResponse
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rule | Rule |
JsonRulesRequest
No description provided.JsonRulesResponse
No description provided.LastValueThreshold
No description provided. This message has no fields.ListRuleVersionsRequest
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rule_id | string | ||
| page_size | uint32 | The maximum number of Rule Versions to return. The service may return fewer than this value. If unspecified, at most 50 Rule Versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | |
| page_token | string | A page token, received from a previous ListRuleVersions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRuleVersions must match the call that provided the page token. | |
| filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are rule_version_id, user_notes, and change_message. For further information about how to use CELs, please refer to this guide. Optional. |
ListRuleVersionsResponse
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rule_versions | RuleVersion | repeated | |
| next_page_token | string |
ListRulesRequest
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| page_size | uint32 | The maximum number of Rules to return. The service may return fewer than this value. If unspecified, at most 50 Rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | |
| page_token | string | A page token, received from a previous ListRules call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRules must match the call that provided the page token. | |
| filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are rule_id, client_key, name, description, is_external, asset_id, tag_id, created_date, created_by_user_id, metadata, modified_date, modified_by_user_id, deleted_date, is_archived, and archived_date. For further information about how to use CELs, please refer to this guide. Optional. | |
| order_by | string | How to order the retrieved Rules. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are created_date and modified_date. If left empty, items are ordered by created_date in descending order (newest-first). |
ListRulesResponse
No description provided.NotificationActionConfiguration
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| recipient_user_ids | string | repeated |
Rule
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rule_id | string | ||
| asset_id | string | Deprecated. | |
| name | string | ||
| description | string | ||
| is_enabled | bool | ||
| created_date | google.protobuf.Timestamp | ||
| modified_date | google.protobuf.Timestamp | ||
| created_by_user_id | string | ||
| modified_by_user_id | string | ||
| organization_id | string | ||
| conditions | RuleCondition | repeated | |
| rule_version | RuleVersion | ||
| client_key | string | client_key is a client provided identifier for the rule. It is immutable after rule creation. | |
| asset_configuration | RuleAssetConfiguration | ||
| contextual_channels | ContextualChannels | ||
| deleted_date | google.protobuf.Timestamp | Deprecated. | |
| is_external | bool | ||
| metadata | sift.metadata.v1.MetadataValue | repeated | |
| archived_date | google.protobuf.Timestamp | archived_date indicates when the rule was archived | |
| is_archived | bool | is_archived is inferred from when archived_date is not null |
RuleAction
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rule_action_id | string | ||
| rule_condition_id | string | ||
| action_type | ActionKind | ||
| configuration | RuleActionConfiguration | ||
| created_date | google.protobuf.Timestamp | ||
| modified_date | google.protobuf.Timestamp | ||
| created_by_user_id | string | ||
| modified_by_user_id | string | ||
| rule_action_version_id | string |
RuleActionConfiguration
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| oneof configuration. notification | NotificationActionConfiguration | ||
| oneof configuration. annotation | AnnotationActionConfiguration |
RuleAssetConfiguration
No description provided.RuleCondition
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rule_condition_id | string | ||
| rule_id | string | ||
| expression | RuleConditionExpression | ||
| created_date | google.protobuf.Timestamp | ||
| modified_date | google.protobuf.Timestamp | ||
| created_by_user_id | string | ||
| modified_by_user_id | string | ||
| actions | RuleAction | repeated | |
| rule_condition_version_id | string |
RuleConditionExpression
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| oneof expression. single_channel_comparison | SingleChannelComparisonExpression | Deprecated. | |
| oneof expression. calculated_channel | CalculatedChannelConfig |
RuleVersion
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rule_id | string | ||
| rule_version_id | string | ||
| version | string | ||
| created_date | google.protobuf.Timestamp | ||
| created_by_user_id | string | ||
| version_notes | string | ||
| generated_change_message | string | ||
| deleted_date | google.protobuf.Timestamp | Deprecated. | |
| archived_date | google.protobuf.Timestamp | archived_date indicates when the rule version was archived | |
| is_archived | bool | is_archived is inferred from when archived_date is not null |
SearchRulesRequest
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| limit | uint32 | optional | Max number of rules to return (returns all if omitted). |
| offset | uint32 | Only applies if limit provided. | |
| order | SearchOrder | optional | Order to sort results by (defaults to ascending). |
| name_matches | string | ||
| case_sensitive | bool | ||
| regexp | bool | ||
| order_by | string | optional | |
| rule_ids | string | repeated | If provided, only returns rules with the given ids |
| asset_ids | string | repeated | If provided, only returns rules that apply to the given asset ids |
| include_deleted | bool | ||
| asset_tags | sift.common.type.v1.NamedResources | If provided, returns rules with assets that have the given tags |
SearchRulesResponse
No description provided.SingleChannelComparisonExpression
Deprecated - use CalculatedChannelConfig.| Field | Type | Label | Description |
|---|---|---|---|
| channel_component | string | Deprecated - use channel_name instead. If provided, channel_component will be joined with the name as channel_component.channel_name | |
| channel_name | string | ||
| comparator | ConditionComparator | ||
| oneof threshold. double | double | ||
| oneof threshold. string | string | ||
| oneof threshold. last_value | LastValueThreshold |
TimeRangeQuery
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| start_time | google.protobuf.Timestamp | ||
| end_time | google.protobuf.Timestamp |
UnarchiveRuleRequest
UnarchiveRuleRequest is used to unarchive a rule by rule_id or client_key. If both are provided, only rule_id will be used.UnarchiveRuleResponse
No description provided. This message has no fields.UndeleteRuleRequest
UndeleteRuleRequest is used to undelete a rule by rule_id or client_key. If both are provided, only rule_id will be used.UndeleteRuleResponse
No description provided. This message has no fields.UpdateActionRequest
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rule_action_id | string | optional | |
| action_type | ActionKind | ||
| configuration | RuleActionConfiguration |
UpdateConditionRequest
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rule_condition_id | string | optional | |
| expression | RuleConditionExpression | ||
| actions | UpdateActionRequest | repeated |
UpdateHumanFriendlyRulesRequest
Deprecated - use UpdateJsonRulesRequest.UpdateHumanFriendlyRulesResponse
Deprecated - use UpdateJsonRulesResponse.UpdateJsonRulesRequest
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| request | JsonRulesRequest |
UpdateJsonRulesResponse
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| response | JsonRulesResponse |
UpdateRuleRequest
UpdateRuleRequest is used to create or update a rule. If the rule_id or client_key is provided, the rule will be updated. If not, a new rule will be created.| Field | Type | Label | Description |
|---|---|---|---|
| rule_id | string | optional | |
| name | string | ||
| description | string | ||
| asset_id | string | Deprecated. Deprecated - use asset_configuration instead. | |
| is_enabled | bool | Deprecated. Deprecated - use DeleteRule instead. | |
| conditions | UpdateConditionRequest | repeated | |
| organization_id | string | ||
| version_notes | string | ||
| client_key | string | optional | client_key is a client provided identifier for the rule. It is immutable after being set |
| asset_configuration | RuleAssetConfiguration | ||
| contextual_channels | ContextualChannels | ||
| is_external | bool | ||
| metadata | sift.metadata.v1.MetadataValue | repeated | |
| is_archived | bool |
UpdateRuleResponse
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rule_id | string |
ValidateJsonRulesRequest
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| request | JsonRulesRequest |
ValidateJsonRulesResponse
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| response | JsonRulesResponse |
ValidationResult
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rule_id | string | ||
| client_key | string | ||
| asset_expression_validation_results | AssetExpressionValidationResult | repeated | If the expression is invalid for an asset, one or more AssetExpressionValidationResult will be returned. This may block saving if the override_expression_validation flag is not set. |
| error | string | optional | If the rule is invalid and unable to be saved, this will contain the error message. Expression errors will be returned in the asset_expression_validation_results. |
ViewHumanFriendlyRulesRequest
Deprecated - use ViewJsonRulesRequest.| Field | Type | Label | Description |
|---|---|---|---|
| asset_id | string |
ViewHumanFriendlyRulesResponse
Deprecated - use ViewJsonRulesResponse.| Field | Type | Label | Description |
|---|---|---|---|
| rules_json | string |
ViewJsonRulesRequest
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| asset_id | string |
ViewJsonRulesResponse
No description provided.| Field | Type | Label | Description |
|---|---|---|---|
| rules_json | string |
Enums
Allowed constant values used in message fields.ActionKind
No description provided.| Name | Number | Description |
|---|---|---|
| ACTION_KIND_UNSPECIFIED | 0 | |
| NOTIFICATION | 1 | |
| ANNOTATION | 2 | |
| WEBHOOK | 3 |
ConditionComparator
No description provided.| Name | Number | Description |
|---|---|---|
| CONDITION_COMPARATOR_UNSPECIFIED | 0 | |
| LESS_THAN | 1 | |
| LESS_THAN_OR_EQUAL | 2 | |
| GREATER_THAN | 3 | |
| GREATER_THAN_OR_EQUAL | 4 | |
| EQUAL | 5 | |
| NOT_EQUAL | 6 |
SearchOrder
No description provided.| Name | Number | Description |
|---|---|---|
| SEARCH_ORDER_UNSPECIFIED | 0 | |
| SEARCH_ORDER_ASC | 1 | |
| SEARCH_ORDER_DESC | 2 |
Services
RPC methods exposed by this API.RuleService
No description provided.| Method | Request | Response | Description |
|---|---|---|---|
| SearchRules | SearchRulesRequest | SearchRulesResponse | Queries rules based on provided search parameters. |
| GetRule | GetRuleRequest | GetRuleResponse | Retrieves the latest version of a rule. |
| BatchGetRules | BatchGetRulesRequest | BatchGetRulesResponse | Retrieve multiple rules. |
| CreateRule | CreateRuleRequest | CreateRuleResponse | Creates a rule. |
| UpdateRule | UpdateRuleRequest | UpdateRuleResponse | Updates an existing rule. |
| BatchUpdateRules | BatchUpdateRulesRequest | BatchUpdateRulesResponse | Updates existing rules or creates rules that do not exist. |
| DeleteRule | DeleteRuleRequest | DeleteRuleResponse | Deprecated - use ArchiveRule instead. Archives a rule. |
| ArchiveRule | ArchiveRuleRequest | ArchiveRuleResponse | Archives a rule. |
| BatchDeleteRules | BatchDeleteRulesRequest | BatchDeleteRulesResponse | Deprecated - use BatchArchiveRules instead. Archives multiple rules. |
| BatchArchiveRules | BatchArchiveRulesRequest | BatchArchiveRulesResponse | Batch archives rules. |
| UnarchiveRule | UnarchiveRuleRequest | UnarchiveRuleResponse | Unarchives a rule. |
| BatchUnarchiveRules | BatchUnarchiveRulesRequest | BatchUnarchiveRulesResponse | Batch unarchives rules. |
| UndeleteRule | UndeleteRuleRequest | UndeleteRuleResponse | Deprecated - use UnarchiveRule instead. Unarchives a rule |
| BatchUndeleteRules | BatchUndeleteRulesRequest | BatchUndeleteRulesResponse | Deprecated - use BatchUnarchiveRules instead. Unarchives multiple rules |
| EvaluateRules | EvaluateRulesRequest | EvaluateRulesResponse | Deprecated - use RuleEvaluationService instead. |
| ViewHumanFriendlyRules | ViewHumanFriendlyRulesRequest | ViewHumanFriendlyRulesResponse | Deprecated - use ViewJsonRules instead. Retrieve a JSON object containing all of the rules for a given asset. |
| ViewJsonRules | ViewJsonRulesRequest | ViewJsonRulesResponse | Deprecated - use BatchGetRules instead. Retrieve a JSON object containing all of the rules for a given asset. |
| UpdateHumanFriendlyRules | UpdateHumanFriendlyRulesRequest | UpdateHumanFriendlyRulesResponse | Deprecated - use BatchUpdateRules instead. Batch update rules given the rules_json which is a JSON list of rules. |
| ValidateJsonRules | ValidateJsonRulesRequest | ValidateJsonRulesResponse | Deprecated - use BatchUpdateRules with validate_only flag instead. Validate a batch update for rules given the rules_json which is a JSON list of rules. This is a dry-run operation. |
| UpdateJsonRules | UpdateJsonRulesRequest | UpdateJsonRulesResponse | Deprecated - use BatchUpdateRules instead. Batch update rules given the rules_json which is a JSON list of rules. |
| ListRules | ListRulesRequest | ListRulesResponse | |
| ListRuleVersions | ListRuleVersionsRequest | ListRuleVersionsResponse | Retrieves a list of rule versions for the given rule. |
| GetRuleVersion | GetRuleVersionRequest | GetRuleVersionResponse | Retrieves a specific version of a rule. |
| BatchGetRuleVersions | BatchGetRuleVersionsRequest | BatchGetRuleVersionsResponse | Retrieves multiple rules by rule versions. |