GET /facet
Summary: Get record counts for one or more facets.
Operation ID: —
Auth: unknown
Operation ID: —
Auth: unknown
Description
Get record counts for one or more facets.
Parameters (19)
absence
(string, query, optional)
Include absence records (include) or get absence records exclusively (true).
areaid
(string, query, optional)
Area ID.
composite
(boolean, query, optional)
Composite aggregation
datasetid
(string, query, optional)
Dataset UUID.
dropped
(string, query, optional)
Include dropped records (include) or get dropped records exclusively (true).
enddate
(string, query, optional)
End date formatted as YYYY-MM-DD.
enddepth
(integer, query, optional)
End depth, in meters.
exclude
(string, query, optional)
Comma separated list of quality flags to be excluded.
facets
(string, query, optional)
Comma separated list of facets (e.g. originalScientificName, flags).
flags
(string, query, optional)
Comma separated list of quality flags which need to be set.
geometry
(string, query, optional)
Geometry, formatted as WKT or GeoHash.
hab
(boolean, query, optional)
HAB species only, true/false.
nodeid
(string, query, optional)
Node UUID.
redlist
(boolean, query, optional)
Red List species only, true/false.
scientificname
(string, query, optional)
Scientific name. Leave empty to include all taxa.
startdate
(string, query, optional)
Start date formatted as YYYY-MM-DD.
startdepth
(integer, query, optional)
Start depth, in meters.
taxonid
(string, query, optional)
Taxon AphiaID.
wrims
(boolean, query, optional)
WRiMS species only, true/false.
Examples (3)
| Title | Type | URL | Action |
|---|---|---|---|
| Get record counts by scientific name facet | curl |
https://api.obis.org/facet?facets=scientificName&scientificname=Mola%20mola |
|
| Get facet counts filtered by date range and area | curl |
https://api.obis.org/facet?facets=dataset_id&areaid=1&startdate=2023-01-01&enddate=2023-12-31 |
|
| Get quality flag distribution for marine mammals | curl |
https://api.obis.org/facet?facets=flags&scientificname=Delphinus%20delphis&composite=true |
Probe History
Status Codes
| Time | Status | Latency | Size |
|---|---|---|---|
| 2026-03-23 10:29:39.009112 | 200 | 234ms | |
| 2026-03-23 09:47:19.623921 | 200 | 749ms | |
| 2026-03-23 09:28:22.617122 | 200 | 912ms |
Response Changes
| When | Old | New |
|---|---|---|
| 2026-03-23 09:47:19.623921 | 62ef21ef337e |
bf78793b414b |
| 2026-03-23 10:29:39.009112 | bf78793b414b |
716cb6218705 |