report_templates

Protocol buffer definition for report_templates

sift/report_templates/v1/report_templates.proto

CreateReportTemplateRequest

The request of a call to ReportTemplateService_CreateReportTemplate to create a report template.

FieldTypeLabelDescription
namestring
client_keystringoptional
descriptionstringoptional
tag_namesstringrepeated
organization_idstringorganization_id is only required if your user belongs to multiple organizations
rule_idsCreateReportTemplateRequestRuleIds
rule_client_keysCreateReportTemplateRequestClientKeys

CreateReportTemplateRequestClientKeys

FieldTypeLabelDescription
rule_client_keysstringrepeated

CreateReportTemplateRequestRuleIds

FieldTypeLabelDescription
rule_idsstringrepeated

CreateReportTemplateResponse

The response of a call to ReportTemplateService_CreateReportTemplate to create a report template.

FieldTypeLabelDescription
report_templateReportTemplate

GetReportTemplateRequest

The request for a call to ReportTemplateService_GetReportTemplate to retrieve a report template. If report_template_id is provided then all other arguments will be ignored. The argument report_template_id should not be used together with client_key. The organization_id argument is only required if using client_key and the user belongs to multiple organizations.

FieldTypeLabelDescription
report_template_idstring
client_keystring
organization_idstring

GetReportTemplateResponse

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

FieldTypeLabelDescription
report_templateReportTemplate

ListReportTemplatesRequest

The request for a call to ReportTemplateService_ListReportTemplates to retrieve report templates.

FieldTypeLabelDescription
page_sizeuint32The maximum number of report templates to return. The service may return fewer than this value. If unspecified, at most 50 report templates 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 ListReportTemplates call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListReportTemplates must match the call that provided the page token. Optional.
filterstringA Common Expression Language (CEL) filter string. Available fields to filter by are report_template_id, tag_id, tag_name, client_key, and name. 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.
include_archivedboolIf true then archived report templates will be included in the query. Defaults to false.
order_bystringHow to order the retrieved report templates. 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"

ListReportTemplatesResponse

The response of a call to ReportTemplateService_ListReportTemplatesResponse.

FieldTypeLabelDescription
report_templatesReportTemplaterepeated
next_page_tokenstring

ReportTemplate

FieldTypeLabelDescription
report_template_idstring
organization_idstring
client_keystringoptional
namestring
descriptionstringoptional
archived_dategoogle.protobuf.Timestampoptional
created_by_user_idstring
modified_by_user_idstring
created_dategoogle.protobuf.Timestamp
modified_dategoogle.protobuf.Timestamp
rulesReportTemplateRulerepeated
tagsReportTemplateTagrepeated

ReportTemplateRule

FieldTypeLabelDescription
rule_idstring
rule_version_idstring
rule_version_numberuint32
client_keystring

ReportTemplateTag

FieldTypeLabelDescription
tag_namestring

UpdateReportTemplateRequest

The request for a call to ReportTemplateService_UpdateReportTemplate to update a report template. 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.

FieldTypeLabelDescription
report_templateReportTemplateThe report template to update.
update_maskgoogle.protobuf.FieldMaskThe list of fields to be updated. The fields available to be updated are name, archived_date, description, tags, and rules.

UpdateReportTemplateResponse

The response of a call to ReportTemplateService_UpdateReportTemplate.

FieldTypeLabelDescription
report_templateReportTemplate

ReportTemplateService

Method NameRequest TypeResponse TypeDescription
GetReportTemplateGetReportTemplateRequestGetReportTemplateResponseRetrieve a report template.
CreateReportTemplateCreateReportTemplateRequestCreateReportTemplateResponseCreate a report template.
ListReportTemplatesListReportTemplatesRequestListReportTemplatesResponseList report templates.
UpdateReportTemplateUpdateReportTemplateRequestUpdateReportTemplateResponseUpdates an existing report template using the list of fields specified in update_mask.

On this page