report_templates

Services

RPC methods exposed by this API.

ReportTemplateService

Method	Request	Response	Description
GetReportTemplate	GetReportTemplateRequest	GetReportTemplateResponse	Retrieve a report template.
CreateReportTemplate	CreateReportTemplateRequest	CreateReportTemplateResponse	Create a report template.
ListReportTemplates	ListReportTemplatesRequest	ListReportTemplatesResponse	List report templates.
UpdateReportTemplate	UpdateReportTemplateRequest	UpdateReportTemplateResponse	Updates an existing report template using the list of fields specified in `update_mask`.

Messages

Data models used across requests/responses.

CreateReportTemplateRequest

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

Field	Type	Label	Description
name	string
client_key	string	optional
description	string	optional
tag_names	string	repeated
organization_id	string		`organization_id` is only required if your user belongs to multiple organizations
oneof rule_identifiers. rule_ids	CreateReportTemplateRequestRuleIds
oneof rule_identifiers. rule_client_keys	CreateReportTemplateRequestClientKeys
metadata	sift.metadata.v1.MetadataValue	repeated

CreateReportTemplateRequestClientKeys

Initial template rule order follows server resolution of keys to rules (not client-defined per-key ordering).

Field	Type	Label	Description
rule_client_keys	string	repeated

CreateReportTemplateRequestRuleIds

Initial rule order on the new template: first rule_id is display_order 0, second is 1, etc.

Field	Type	Label	Description
rule_ids	string	repeated

CreateReportTemplateResponse

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

Field	Type	Label	Description
report_template	ReportTemplate

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.

Field	Type	Label	Description
report_template_id	string
client_key	string
organization_id	string

GetReportTemplateResponse

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

Field	Type	Label	Description
report_template	ReportTemplate

ListReportTemplatesRequest

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

Field	Type	Description
page_size	uint32	The 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_token	string	A 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.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are `report_template_id`, `tag_id`, `tag_name`, `client_key`, `metadata`, `name` and ‘is_archived’. 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	Deprecated. Deprecated. Use `filter` instead.
order_by	string	How 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 descending order (newest-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.

Field	Type	Label	Description
report_templates	ReportTemplate	repeated
next_page_token	string

ReportTemplate

Field	Type	Label	Description
report_template_id	string
organization_id	string
client_key	string	optional
name	string
description	string	optional
archived_date	google.protobuf.Timestamp	optional
created_by_user_id	string
modified_by_user_id	string
created_date	google.protobuf.Timestamp
modified_date	google.protobuf.Timestamp
rules	ReportTemplateRule	repeated	Rules on this template. On responses, sort by each rule’s `display_order` ascending for execution order. On writes, if `display_order` is omitted on a rule, that rule’s position follows the slice order of `rules` (same as explicit orders 0..n-1).
tags	ReportTemplateTag	repeated
metadata	sift.metadata.v1.MetadataValue	repeated
is_archived	bool		Whether the report template is archived. This is inferred from whether archived_date is set.

ReportTemplateRule

Field	Type	Label	Description
rule_id	string
rule_version_id	string
rule_version_number	uint32
client_key	string
display_order	uint32	optional	Zero-based order for this rule on the template. Copied to `ReportRuleSummary.display_order` when creating a report from the template. Lower values indicate earlier position in the template and on generated reports.

Optional on writes (e.g. UpdateReportTemplate): if omitted, servers use the order of entries in ReportTemplate.rules (first entry is earliest). On reads, this field is always populated. |

ReportTemplateTag

Field	Type	Label	Description
tag_name	string

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.

Field	Type	Label	Description
report_template	ReportTemplate		The report template 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`, `rules`, and `metadata`.

UpdateReportTemplateResponse

The response of a call to ReportTemplateService_UpdateReportTemplate.

Field	Type	Label	Description
report_template	ReportTemplate

Enums

Allowed constant values used in message fields.

Authenticate

Clients

Review

Export

Endpoints & protobuf definitions

report_templates

Services