Skip to content

Commit

Permalink
docs: event filters page
Browse files Browse the repository at this point in the history
  • Loading branch information
aviau committed Aug 26, 2024
1 parent 8400bea commit 4f3798a
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/advanced/event-filters.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "Event Filters"
---

The Flare event feeds allow for searching and filtering using a `type` parameter that defines which
events types should be included in the response.

Flare API endpoints accept either **Base Types** or **Categories** as values.

| Filter | Description |
| ------ | ----------- |
| Base Type | Enables a single event type. |
| Category | Enables a group of base types. |

## Categories

Base Types are divided into categories that correspond to the categories in the Flare platform.

| Category | Contained Types |
| -------- | --------------- |
| illicit_networks | forum_content <br /> blog_content <br /> profile <br /> chat_message <br /> ransomleak <br /> infected_devices <br /> financial_data |
| open_web | paste <br /> social_media <br /> source_code <br /> google <br /> service <br /> buckets |
| buckets | bucket <br /> bucket_object <br />
| source_code | stack_exchange <br /> source_code_files <br /> source_code_secret |
| leaks | leak |
| domains | domain |
| forum_content | forum_post <br /> forum_topic |
| profile | forum_profile <br /> seller |
| infected_devices | bot <br /> stealer_log |
6 changes: 6 additions & 0 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,12 @@
"concepts/paging"
]
},
{
"group": "Advanced",
"pages": [
"advanced/event-filters"
]
},
{
"group": "Guides (more coming soon)",
"pages": [
Expand Down

0 comments on commit 4f3798a

Please sign in to comment.