ReportTemplateService

ListReportTemplates

List report templates.

get/api/v1/report-templates

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/report-templates
  • Auth: HTTP bearer

Query parameters

pageSizeinteger

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.

pageTokenstring

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.

filterstring

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.

organizationIdstring

This field is only required if your user belongs to multiple organizations.

includeArchivedboolean

Deprecated. Use filter instead.

orderBystring

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"

Response

A successful response.

nextPageTokenstring

Changes

No recorded changes to this operation across all 1 revision of this API.