reports

Protocol buffer definition for reports

sift/reports/v1/reports.proto

CancelReportRequest

FieldTypeLabelDescription
report_idstring

CancelReportResponse

no response fields

CreateReportFromReportTemplateRequest

Used to create a report from a report template.

FieldTypeLabelDescription
report_template_idstring

CreateReportFromRulesRequest

Used to construct an arbitrary report for an arbitrary set of rules. Rules can be specified either by rule ID or client key based on the variant used in the rule_identifiers field.

FieldTypeLabelDescription
namestring
descriptionstringoptional
tag_namesstringrepeated
rule_idsCreateReportRequestRuleIds
rule_client_keysCreateReportRequestClientKeys

CreateReportRequest

The request of a call to ReportService_CreateReport to create a report. A report can be created either via a report template or an arbitrary report can be constructed depending on the variant of the request field.

FieldTypeLabelDescription
report_from_report_template_requestCreateReportFromReportTemplateRequest
report_from_rules_requestCreateReportFromRulesRequest
organization_idstring
run_idstring
namestringoptionalOverride the name of the report. If not provided, the name will be generated based on the report template or run.

CreateReportRequestClientKeys

FieldTypeLabelDescription
rule_client_keysstringrepeated

CreateReportRequestRuleIds

FieldTypeLabelDescription
rule_idsstringrepeated

CreateReportResponse

The response of a call to ReportService_CreateReport to create a report.

FieldTypeLabelDescription
reportReport

GetReportRequest

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

FieldTypeLabelDescription
report_idstring

GetReportResponse

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

FieldTypeLabelDescription
reportReport

ListReportsRequest

The request for a call to ReportService_ListReports to retrieve report.

FieldTypeLabelDescription
page_sizeuint32The 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_tokenstringA 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.
filterstringA Common Expression Language (CEL) filter string. Available fields to filter by are report_id, report_template_id, tag_name, name, and run_id. 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_idstringThis field is only required if your user belongs to multiple organizations.
order_bystringHow to order the retrieved reports. 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 ascending order (oldest-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.

FieldTypeLabelDescription
reportsReportrepeated
next_page_tokenstring

Report

FieldTypeLabelDescription
report_idstring
report_template_idstring
run_idstring
organization_idstring
namestring
descriptionstringoptional
created_by_user_idstring
modified_by_user_idstring
created_dategoogle.protobuf.Timestamp
modified_dategoogle.protobuf.Timestamp
summariesReportRuleSummaryrepeated
tagsReportTagrepeated
rerun_from_report_idstringoptional

ReportRuleStatusDetails

ReportRuleStatusDetailsCreated

ReportRuleStatusDetailsFailed

FieldTypeLabelDescription
error_messagestring

ReportRuleStatusDetailsFinished

ReportRuleStatusDetailsLive

ReportRuleSummary

FieldTypeLabelDescription
rule_idstring
rule_client_keystring
rule_version_idstring
rule_version_numberuint32
report_rule_version_idstring
num_openuint32
num_faileduint32
num_passeduint32
statusReportRuleStatus
status_detailsReportRuleStatusDetails
created_dategoogle.protobuf.Timestamp
modified_dategoogle.protobuf.Timestamp
asset_idstring

ReportTag

FieldTypeLabelDescription
tag_namestring

RerunReportRequest

FieldTypeLabelDescription
report_idstring

RerunReportResponse

FieldTypeLabelDescription
job_idstring
report_idstring

ReportRuleStatus

NameNumberDescription
REPORT_RULE_STATUS_UNSPECIFIED0
REPORT_RULE_STATUS_CREATED1
REPORT_RULE_STATUS_LIVE2
REPORT_RULE_STATUS_FINISHED3
REPORT_RULE_STATUS_FAILED4
REPORT_RULE_STATUS_CANCELED5

ReportService

Method NameRequest TypeResponse TypeDescription
GetReportGetReportRequestGetReportResponseRetrieve a report.
CreateReportCreateReportRequestCreateReportResponseCreate a report.
ListReportsListReportsRequestListReportsResponseList reports.
RerunReportRerunReportRequestRerunReportResponseRerunning 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.
CancelReportCancelReportRequestCancelReportResponseCanceling 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.

On this page