ListReportTemplates

GET

/api/v1/report-templates

Query Parameters

`pageSize`integer

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.

Format: "int64"

`pageToken`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, 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.

`organizationId`string

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

`includeArchived`boolean

If true then archived report templates will be included in the query. Defaults to false.

`orderBy`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 ascending order (oldest-first). For more information about the format of this field, read this Example: "created_date desc,modified_date"

curl -X GET "<API_URL>/api/v1/report-templates?pageSize=0&pageToken=string&filter=string&organizationId=string&includeArchived=true&orderBy=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "reportTemplates": [
    {
      "reportTemplateId": "string",
      "organizationId": "string",
      "clientKey": "string",
      "name": "string",
      "description": "string",
      "archivedDate": "2019-08-24T14:15:22Z",
      "createdByUserId": "string",
      "modifiedByUserId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "rules": [
        {
          "ruleId": "string",
          "ruleVersionId": "string",
          "ruleVersionNumber": 0,
          "clientKey": "string"
        }
      ],
      "tags": [
        {
          "tagName": "string"
        }
      ]
    }
  ],
  "nextPageToken": "string"
}

ListReportTemplates

Query Parameters

pageSizeinteger

pageTokenstring

filterstring

organizationIdstring

includeArchivedboolean