ReportService

ListReportRuleSummaries

List paginated rule summaries for a specific report.

get/api/v1/reports/{reportId}/rule-summaries

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/reports/{reportId}/rule-summaries
  • Auth: HTTP bearer

Path parameters

reportIdstring required

The report whose rule summaries to list.

Query parameters

pageSizeinteger

The maximum number of rule summaries to return. The service may return fewer than this value. If unspecified, at most 50 rule summaries 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 ListReportRuleSummaries call. Provide this to retrieve the subsequent page. Optional.

filterstring

A Common Expression Language (CEL) filter string. Available fields to filter by are rule_id, rule_version_id, asset_id, status, created_date, and modified_date. Optional.

orderBystring

How to order the retrieved rule summaries. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order by are display_order, created_date, and modified_date. If left empty, items are ordered by display_order ascending.

Response

A successful response.

nextPageTokenstring

Changes

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