campaigns

Services

RPC methods exposed by this API.

CampaignService

Method	Request	Response	Description
GetCampaign	GetCampaignRequest	GetCampaignResponse	Retrieve a campaign.
CreateCampaign	CreateCampaignRequest	CreateCampaignResponse	Create a campaign.
ListCampaigns	ListCampaignsRequest	ListCampaignsResponse	List campaigns.
UpdateCampaign	UpdateCampaignRequest	UpdateCampaignResponse	Updates an existing campaign using the list of fields specified in `update_mask`.
ListCampaignAnnotations	ListCampaignAnnotationsRequest	ListCampaignAnnotationsResponse	List campaigns.
GetCampaignReportSummaries	GetCampaignReportSummariesRequest	GetCampaignReportSummariesResponse	Returns per-campaign report summaries (annotation totals + rule classifications) in bulk. Each campaign maps to its list of CampaignReport entries with summary fields populated. Intended for use alongside ListCampaigns with skip_report_summaries=true.

Messages

Data models used across requests/responses.

Campaign

Field	Type	Label	Description
campaign_id	string
organization_id	string
client_key	string	optional
name	string
description	string	optional
created_by_user_id	string
modified_by_user_id	string
created_date	google.protobuf.Timestamp
modified_date	google.protobuf.Timestamp
archived_date	google.protobuf.Timestamp
tags	sift.tags.v1.TagRef	repeated
reports	CampaignReport	repeated	A campaign, at its core, is a list of reports
created_from_campaign_id	string	optional	If this campaign was created by duplicating another campaign, that other campaign will be referenced here
metadata	sift.metadata.v1.MetadataValue	repeated	User-defined metadata for this campaign
is_archived	bool		Whether the campaign. This is inferred from whether archived_date is set.
reports_include_summaries	bool		Indicates whether the summary fields on CampaignReport (num_annotations, num_passed_rules, num_accepted_rules, num_failed_rules, num_open_rules) are populated. When false, those fields should be ignored — use GetCampaignReportSummaries to fetch the summary data separately.

CampaignReport

A top-level summary of the report’s rules is provided here so clients needn’t aggregate this information themselves.

Field	Type	Description
report_id	string	Direct reference to the report. Set this on the client to tell the backend which report you’re referring to.
report_name	string
num_annotations	uint32	How many annotations exist under the report’s various rules.
num_passed_rules	uint32	How many rules from this report were never triggered and generated NO annotations.
num_accepted_rules	uint32	How many rules have annotations which are ALL marked as accepted.
num_failed_rules	uint32	How many rules have ANY annotations which are marked as failed.
num_open_rules	uint32	How many rules have annotations of which SOME are marked as open and NONE are marked as failed.

CampaignReports

Wrapper for repeated CampaignReport used in map values (proto3 maps cannot directly contain repeated fields).

Field	Type	Label	Description
reports	CampaignReport	repeated

CreateCampaignFrom

Campaigns can be created from a few different sources.

Field	Type	Description
oneof initializer. reports	sift.common.type.v1.ResourceIdentifiers	Create a campaign directly from a set of reports
oneof initializer. runs	sift.common.type.v1.ResourceIdentifiers	Create a campaign from a set of runs by collecting all the reports generated by those runs
oneof initializer. other_campaign	sift.common.type.v1.ResourceIdentifier	Duplicate another campaign

CreateCampaignRequest

The request of a call to CampaignService_CreateCampaign to create a campaign.

Field	Type	Label	Description
name	string		The descriptive display name of the created campaign
description	string	optional	A custom description for the campaign
tags	sift.common.type.v1.NamedResources		Tags to be applied to the new campaign
organization_id	string		`organization_id` is only required if your user belongs to multiple organizations
client_key	string	optional	User-specified unique identifier.
create_from	CreateCampaignFrom		Initialize the campaign, or leave this field empty to create an empty campaign to be populated later
metadata	sift.metadata.v1.MetadataValue	repeated	User-defined metadata for this campaign

CreateCampaignResponse

The response of a call to CampaignService_CreateCampaign to create a campaign.

Field	Type	Label	Description
campaign	Campaign

GetCampaignReportSummariesRequest

Field	Type	Label	Description
campaign_ids	string	repeated
organization_id	string		This field is only required if your user belongs to multiple organizations.

GetCampaignReportSummariesResponse

Field	Type	Label	Description
summaries_by_campaign_id	GetCampaignReportSummariesResponse.SummariesByCampaignIdEntry	repeated	Keyed by campaign_id. Each value contains the full list of CampaignReport entries for that campaign with summary fields (num_*) populated.

GetCampaignReportSummariesResponse.SummariesByCampaignIdEntry

Field	Type	Label	Description
key	string
value	CampaignReports

GetCampaignRequest

The request for a call to CampaignService_GetCampaign to retrieve a campaign. If campaign_id is provided then all other arguments will be ignored. The organization_id argument is only required if using client_key and the user belongs to multiple organizations.

Field	Type	Description
campaign_id	string
client_key	string
organization_id	string
skip_report_summaries	bool	If `true`, the response will omit the summary fields on the campaign’s reports and set reports_include_summaries to false on the Campaign message. Reports will still be included with report_id and report_name populated. This significantly improves response times for campaigns with many reports. Defaults to `false`.

GetCampaignResponse

The response of a call to CampaignService_GetCampaign to retrieve a campaign.

Field	Type	Label	Description
campaign	Campaign

ListCampaignAnnotationsRequest

Field	Type	Description
campaign_id	string
page_size	uint32	The maximum number of annotations to return. The service may return fewer than this value. If unspecified, at most 50 annotations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.
page_token	string	A page token, received from a previous `ListAnnotations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAnnotations` must match the call that provided the page token. Optional.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are `annotation_id`, `start_time`, `end_time`, `created_date`, `modified_date`, `run_id`, `name`, `description`, `state`, `created_by_user_id`, `created_by_rule_condition_version_id`, `annotation_type`, `tag_name`, `report_id`, `asset_id`, `asset_name`, `pending`, `assignee`, and `metadata`. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.
order_by	string	How to order the retrieved annotations. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are `created_date`, `modified_date`, `start_time`, and `end_time`. If left empty, items are ordered by `created_date` in ascending order (oldest-first). For more information about the format of this field, read this Example: “created_date desc,modified_date”

ListCampaignAnnotationsResponse

Field	Type	Label	Description
annotations	sift.annotations.v1.Annotation	repeated
next_page_token	string

ListCampaignsRequest

The request for a call to CampaignService_ListCampaigns to retrieve campaigns.

Field	Type	Description
page_size	uint32	The maximum number of campaigns to return. The service may return fewer than this value. If unspecified, at most 50 campaigns will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.
page_token	string	A page token, received from a previous `ListCampaigns` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCampaigns` must match the call that provided the page token. Optional.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are: `created_by_user_id`, `tag_id`, `tag_name`, `report_id`, `report_name`, `campaign_id`, `client_key`, `description`, `run_id`, `name`, `is_archived`, and `metadata`. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.
organization_id	string	This field is only required if your user belongs to multiple organizations.
include_archived	bool	If `true` then archived campaigns will be included in the query. Defaults to `false`.
order_by	string	How to order the retrieved campaigns. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are `name`, `created_date` and `modified_date`. If left empty, items are ordered by `created_date` in descending order (newest-first). For more information about the format of this field, read this Example: “created_date desc,modified_date”
skip_report_summaries	bool	If `true`, the response will omit the summary fields on each campaign’s reports and set reports_include_summaries to false on the Campaign message. Reports will still be included with report_id and report_name populated. This significantly improves response times for campaigns with many reports. Defaults to `false`.

ListCampaignsResponse

The response of a call to CampaignService_ListCampaignsResponse.

Field	Type	Label	Description
campaigns	Campaign	repeated
next_page_token	string

UpdateCampaignRequest

The request for a call to CampaignService_UpdateCampaign to update a campaign. When updating tags or rules, the update will perform a full replace. Additionally, when updating rules, only the rule ID or the rule client key is required, but it is okay to provide both. If some rules contain only client keys and others only rule IDs, they will be consolidated.

Field	Type	Label	Description
campaign	Campaign		The campaign to update.
update_mask	google.protobuf.FieldMask		The list of fields to be updated. The fields available to be updated are `name`, `archived_date`, `is_archived`, `description`, `tags`, `reports`, and `metadata`.

UpdateCampaignResponse

The response of a call to CampaignService_UpdateCampaign.

Field	Type	Label	Description
campaign	Campaign

Enums

Allowed constant values used in message fields.

Authenticate

Clients

Review

Export

Endpoints & protobuf definitions

Services

CampaignService

Messages

Campaign

CampaignReport

CampaignReports

CreateCampaignFrom

CreateCampaignRequest

CreateCampaignResponse

GetCampaignReportSummariesRequest

GetCampaignReportSummariesResponse

GetCampaignReportSummariesResponse.SummariesByCampaignIdEntry

GetCampaignRequest

GetCampaignResponse

ListCampaignAnnotationsRequest

ListCampaignAnnotationsResponse

ListCampaignsRequest

ListCampaignsResponse

UpdateCampaignRequest

UpdateCampaignResponse

Enums

​Services

​CampaignService

​Messages

​Campaign

​CampaignReport

​CampaignReports

​CreateCampaignFrom

​CreateCampaignRequest

​CreateCampaignResponse

​GetCampaignReportSummariesRequest

​GetCampaignReportSummariesResponse

​GetCampaignReportSummariesResponse.SummariesByCampaignIdEntry

​GetCampaignRequest

​GetCampaignResponse

​ListCampaignAnnotationsRequest

​ListCampaignAnnotationsResponse

​ListCampaignsRequest

​ListCampaignsResponse

​UpdateCampaignRequest

​UpdateCampaignResponse

​Enums

Services

CampaignService

Messages

Campaign

CampaignReport

CampaignReports

CreateCampaignFrom

CreateCampaignRequest

CreateCampaignResponse

GetCampaignReportSummariesRequest

GetCampaignReportSummariesResponse

GetCampaignReportSummariesResponse.SummariesByCampaignIdEntry

GetCampaignRequest

GetCampaignResponse

ListCampaignAnnotationsRequest

ListCampaignAnnotationsResponse

ListCampaignsRequest

ListCampaignsResponse

UpdateCampaignRequest

UpdateCampaignResponse

Enums