Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions internal/portal/src/common/FilterSyntaxGuide/FilterSyntaxGuide.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,21 @@ Only events matching the filter will be delivered. Filters use JSON to define ma

## Event Structure

Events contain two top-level properties that can be filtered:
Events have five top-level properties that can be filtered:

- \`data\` — The event payload
- \`id\` — The event ID
- \`topic\` — The event topic
- \`time\` — Event timestamp (RFC3339 format)
- \`metadata\` — Additional event information
- \`data\` — The event payload

Your filter should specify one or both of these at the top level:
Your filter should specify one or more of these at the top level:

\`\`\`json
{
"topic": "order.created",
"data": {
"type": "order.created"
"status": "paid"
},
"metadata": {
"source": "api"
Expand Down Expand Up @@ -116,6 +120,17 @@ Use operators for complex matching:
}
\`\`\`

**Example:** Match events within a time range

\`\`\`json
{
"time": {
"$gte": "2025-01-01T00:00:00Z",
"$lt": "2025-02-01T00:00:00Z"
}
}
\`\`\`

## Combining Operators

Multiple operators on the same field are combined with AND:
Expand Down