Skip to main content
POST
Preview behavior event rules

Restrictions

Usage

  • start_time and end_time are Unix epoch milliseconds. Omit both to use the last 7 days; a range wider than 14 days returns InvalidParameter.
  • The caller needs read access to application_id; data of private applications the caller cannot access is not counted.
  • Nothing is saved: the rules are compiled to SQL and evaluated for this call only.
  • except_event_id leaves that event out of overlaps, typically the event being edited.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Evaluate unsaved rules against the stored actions.

application_id
string
required

RUM application ID. The caller needs read access to it; for write operations, manage access.

rules
object[]
required

Rules of the event. They are OR-ed: a raw action belongs to the event when any rule matches it. 1-20 rules.

Required array length: 1 - 20 elements
end_time
integer<int64>

End of the window, Unix timestamp in milliseconds. Defaults to now when omitted.

Example:

1780358400000

except_event_id
string

Event to leave out of the overlap list, typically the one being edited.

start_time
integer<int64>

Start of the window, Unix timestamp in milliseconds. Omit both bounds to use the last 7 days; a range wider than 14 days is rejected.

Example:

1780272000000

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

What unsaved rules would match, without saving them.