This article explains your options for exporting rules (contact filters) and their configured values from the platform, and how to work with related data when a direct export is not available.
Overview
The platform does not provide a built-in option to export a single report that lists all rules and their configured values. In the reporting UI, rule definitions and their values are not available as reportable fields, so they cannot be added to custom reports or standard exports.
Instead, you can review rule configuration directly in the UI or use the public API to retrieve rule definitions and contacts, then combine them to create your own rules report.
Limitations
The following limitations apply when working with rules (contact filters) and their configuration values:
- The reporting UI does not expose rules or rule configuration values as reportable fields.
- You cannot create a single, native report that lists all rules and their configuration values directly from the UI.
- Report Builder cannot include rules or rule configuration values, even though it supports several other data types.
What you can do with Report Builder
Report Builder is available under the Reports tab via + Create Report. It can create custom reports for several data types, such as notifications, incidents, contacts, and scenarios. You choose a report type and drag available fields into the DATA and FILTERS sections.
However, rules themselves and their configuration values are not included in these available fields, so they cannot be exported directly via Report Builder.
UI-based workarounds
- If you only need to review how rules are configured, you can open and review rule settings directly in the web interface.
- For rule-related analysis that can be derived from other objects, you can use Report Builder to export related items (for example, notifications, incidents, or templates) that contain any rule-related fields you require.
Exporting rules and values via the API
To build a report of rules and their configuration values, you can use the public API instead of the reporting UI. The platform’s export interface does not expose rules and values, but the API does allow you to retrieve rule definitions and contacts, then combine them.
Prerequisites and references
- Access to the Everbridge API, including authentication details.
- Developer documentation: Everbridge developer getting started guide.
- API reference and Swagger UI: https://api.everbridge.net/#/.
- Endpoint references:
- List contact filters (rules): /contactFilters
- List contacts: /contacts
Step 1: Retrieve rule definitions
- Call the /contactFilters endpoint.
- Retrieve your rules (contact filters) from the response.
The records returned typically include:
- Rule name
- Rule ID
- Last modified date
- Last modified by
- Rule configuration (the filter criteria that define the rule)
You can use this data as the basis of your rules report, including both metadata and the configuration values embedded in each rule’s filter criteria.
Step 2: Retrieve contacts
- Call the /contacts endpoint.
- Export your current contact records from the response.
This gives you the dataset needed to understand which contacts are selected by each rule.
Step 3: Combine rule and contact data
- Use the rule configuration (filter criteria) from the /contactFilters response.
- Apply each rule’s filter criteria to the contacts dataset returned by /contacts.
- Evaluate the rule logic against your contacts.
By evaluating the rule logic against your contacts, you can build a combined report that shows, for each rule, its configuration values along with the contacts that meet those criteria.
Requesting a native rules export feature
If you require a full, one-click export of all rules and their values directly from the UI, and the current API approach does not meet your needs, you can submit this requirement through your product feedback channel for consideration in a future release.
While the product team has been asked to add this capability, there is no guaranteed timeline, so using the API is the recommended method today for a complete rules export.