Skip to content

events: document matched_at filter and sort order field #274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xvaier merged 1 commit into from
Oct 21, 2026
Merged

events: document matched_at filter and sort order field #274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
59 changes: 58 additions & 1 deletion docs/snippets/endpoint-event-search-common.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,17 @@ This endpoint supports the
The `next` value from the last response.
</ParamField>

<ParamField body="sort" type="string" default="matched_at">
Date field used to sort the results.

<Expandable title="valid sort values">
`matched_at`
`estimated_created_at`
</Expandable>
</ParamField>

<ParamField body="order" type="string" default="desc">
Sort order of the results by matched date (`matched_at`).
Sort order of the results by the `sort` field.

<Expandable title="valid order values">
`asc`
Expand Down Expand Up @@ -198,6 +207,54 @@ This endpoint supports the
</ParamField>

<ParamField body="estimated_created_at" type="object">
Filters on the estimated date the event was created on its source.

<Expandable>
<ParamField
body="gt"
type="string"
placeholder="Example: 2024-01-01T00:00:00+00:00"
>
Matches values greater than the specified timestamp.

Format: ISO-8601
</ParamField>

<ParamField
body="gte"
type="string"
placeholder="Example: 2024-01-01T00:00:00+00:00"
>
Matches values greater than or equal to the specified timestamp.

Format: ISO-8601
</ParamField>

<ParamField
body="lt"
type="string"
placeholder="Example: 2024-01-01T00:00:00+00:00"
>
Matches values lesser than the specified timestamp.

Format: ISO-8601
</ParamField>

<ParamField
body="lte"
type="string"
placeholder="Example: 2024-01-01T00:00:00+00:00"
>
Matches values lesser than or equal to the specified timestamp.

Format: ISO-8601
</ParamField>
</Expandable>
</ParamField>

<ParamField body="matched_at" type="object">
Filters on the date the event was matched to the tenant's identifiers.

<Expandable>
<ParamField
body="gt"
Expand Down
2 changes: 2 additions & 0 deletions docs/snippets/endpoint-global-search-event.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,8 @@ This endpoint supports the
</ParamField>

<ParamField body="estimated_created_at" type="object">
Filters on the estimated date the event was created on its source.

<Expandable>
<ParamField
body="gt"
Expand Down
Loading