Skip to content

Commit

Permalink
added all filters to filter summary table
Browse files Browse the repository at this point in the history
  • Loading branch information
nachomaiz committed Oct 17, 2023
1 parent a64a1ee commit 44afb95
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions docs/usage/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,17 @@ In order to validate the request parameters before sending a bad request, `bavap

Each endpoint has a filter class associated with it, as each endpoint has its own filter requirements:

| Endpoint | Filters class |
| ------------------- | ------------------------------------------------ |
| `"audiences"` | [`AudiencesFilters`][filters.AudiencesFilters] |
| `"brands"` | [`BrandsFilters`][filters.BrandsFilters] |
| `"brandscape-data"` | [`BrandscapeFilters`][filters.BrandscapeFilters] |
| `"studies"` | [`StudiesFilters`][filters.StudiesFilters] |
| Endpoint | Filters class |
| ----------------------- | -------------------------------------------------------------- |
| `"audiences"` | [`AudiencesFilters`][filters.AudiencesFilters] |
| `"brand-metric-groups"` | [`BrandMetricGroupsFilters`][filters.BrandMetricGroupsFilters] |
| `"brand-metrics"` | [`BrandMetricsFilters`][filters.BrandMetricsFilters] |
| `"brands"` | [`BrandsFilters`][filters.BrandsFilters] |
| `"brandscape-data"` | [`BrandscapeFilters`][filters.BrandscapeFilters] |
| `"categories"` | [`CategoriesFilters`][filters.CategoriesFilters] |
| `"collections"` | [`CollectionsFilters`][filters.CollectionsFilters] |
| `"sectors"` | [`SectorsFilters`][filters.SectorsFilters] |
| `"studies"` | [`StudiesFilters`][filters.StudiesFilters] |

!!! warning
Using a filters class not meant for a specific endpoint will raise a `ValueError`.
Expand Down

0 comments on commit 44afb95

Please sign in to comment.