API Reference gRPC (Protocol Buffers)

reports

Protocol buffer definition for reports

sift/reports/v1/reports.proto

CancelReportRequest

Field	Type	Label	Description
report_id	string

CancelReportResponse

no response fields

CreateReportFromReportTemplateRequest

Deprecated - use RuleEvaluationService instead.

Field	Type	Label	Description
report_template_id	string

CreateReportFromRulesRequest

Deprecated - use RuleEvaluationService instead.

Field	Type	Label	Description
name	string
description	string	optional
tag_names	string	repeated
oneof rule_identifiers.rule_ids	CreateReportRequestRuleIds
oneof rule_identifiers.rule_client_keys	CreateReportRequestClientKeys

CreateReportRequest

Deprecated - use RuleEvaluationService instead.

Field	Type	Label	Description
oneof request.report_from_report_template_request	CreateReportFromReportTemplateRequest
oneof request.report_from_rules_request	CreateReportFromRulesRequest
organization_id	string
run_id	string
name	string	optional	Override the name of the report. If not provided, the name will be generated based on the report template or run.
metadata	sift.metadata.v1.MetadataValue	repeated

CreateReportRequestClientKeys

Deprecated - use RuleEvaluationService instead.

Field	Type	Label	Description
rule_client_keys	string	repeated

CreateReportRequestRuleIds

Deprecated - use RuleEvaluationService instead.

Field	Type	Label	Description
rule_ids	string	repeated

CreateReportResponse

Deprecated - use RuleEvaluationService instead.

Field	Type	Label	Description
report	Report

GetReportRequest

The request for a call to ReportService_GetReport to retrieve a report template.

Field	Type	Label	Description
report_id	string

GetReportResponse

The request of a call to ReportService_GetReport to retrieve a report template.

Field	Type	Label	Description
report	Report

ListReportsRequest

The request for a call to ReportService_ListReports to retrieve report.

Field	Type	Label	Description
page_size	uint32		The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 50 reports 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 `ListReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReports` 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 `report_id`, `report_template_id`, `tag_name`, `name`, `run_id`, and `archived_date`. 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.
order_by	string		How to order the retrieved reports. 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"

ListReportsResponse

The response of a call to ReportService_ListReportsResponse.

Field	Type	Label	Description
reports	Report	repeated
next_page_token	string

Report

Field	Type	Label	Description
report_id	string
report_template_id	string
run_id	string
organization_id	string
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
summaries	ReportRuleSummary	repeated
tags	ReportTag	repeated
rerun_from_report_id	string	optional
job_id	string	optional
archived_date	google.protobuf.Timestamp	optional
metadata	sift.metadata.v1.MetadataValue	repeated

ReportRuleStatusDetails

Field	Type	Label	Description
oneof details.created	ReportRuleStatusDetailsCreated
oneof details.live	ReportRuleStatusDetailsLive
oneof details.finished	ReportRuleStatusDetailsFinished
oneof details.failed	ReportRuleStatusDetailsFailed
oneof details.canceled	ReportRuleStatusDetailsCanceled
oneof details.error	ReportRuleStatusDetailsError

ReportRuleStatusDetailsCanceled

ReportRuleStatusDetailsCreated

ReportRuleStatusDetailsError

Field	Type	Label	Description
error_message	string
exit_code	int32	optional
stdout	string	optional
stderr	string	optional

ReportRuleStatusDetailsFailed

Field	Type	Label	Description
error_message	string
exit_code	int32	optional
stdout	string	optional
stderr	string	optional

ReportRuleStatusDetailsFinished

Field	Type	Label	Description
stdout	string	optional
stderr	string	optional

ReportRuleStatusDetailsLive

ReportRuleSummary

Field	Type	Label	Description
rule_id	string
rule_client_key	string
rule_version_id	string
rule_version_number	uint32
report_rule_version_id	string
num_open	uint32
num_failed	uint32
num_passed	uint32
status	ReportRuleStatus
status_details	ReportRuleStatusDetails
created_date	google.protobuf.Timestamp
modified_date	google.protobuf.Timestamp
asset_id	string
deleted_date	google.protobuf.Timestamp

ReportTag

Field	Type	Label	Description
tag_name	string

RerunReportRequest

Field	Type	Label	Description
report_id	string

RerunReportResponse

Field	Type	Label	Description
job_id	string
report_id	string

UpdateReportRequest

Field	Type	Label	Description
report	Report		The report to update.
update_mask	google.protobuf.FieldMask		The list of fields to be updated. The fields available to be updated are `archived_date` and `metadata`.

UpdateReportResponse

no response fields

ReportRuleStatus

Name	Number	Description
REPORT_RULE_STATUS_UNSPECIFIED	0
REPORT_RULE_STATUS_CREATED	1
REPORT_RULE_STATUS_LIVE	2
REPORT_RULE_STATUS_FINISHED	3
REPORT_RULE_STATUS_FAILED	4
REPORT_RULE_STATUS_CANCELED	5
REPORT_RULE_STATUS_ERROR	6

ReportService

Method Name	Request Type	Response Type	Description
GetReport	GetReportRequest	GetReportResponse	Retrieve a report.
CreateReport	CreateReportRequest	CreateReportResponse	Deprecated - use RuleEvaluationService instead.
UpdateReport	UpdateReportRequest	UpdateReportResponse	Update a report.
ListReports	ListReportsRequest	ListReportsResponse	List reports.
RerunReport	RerunReportRequest	RerunReportResponse	Rerunning a report will create a new report with the same rule versions and run as the original report and run the evaluation again using the most up-to-date set of data.
CancelReport	CancelReportRequest	CancelReportResponse	Canceling a report will stop the evaluation of the report and mark it as canceled. Any results that have been calculated up to the point of cancellation will be saved.

Previous

report_templates

Next

resource_identifier