Skip to main content
This endpoint uses monitored-entity as its path segment, while the rest of this API and product documentation use metered entity (see Core Concepts and GET /metered-entities). Whether these refer to the same resource under an inconsistent name, or something distinct, isn’t confirmed — treat this page as provisional until that’s resolved.

Endpoint

Returns the filter facets available for narrowing a monitored-entity listing, scoped to the organization(s) in orgIds — the same pattern used by GET /variable/get-variable-filter-data for variables.

Parameters

Example request

Single organization:
Multiple organizations — pass more than one id to get filters scoped across all of them:
Ids in the examples on this page follow the same convention as Variable List: ids identifying a specific real-world record (organizations, and the per-organization entries under tags) are shown as anonymized 8-character placeholders — reusing the same id already assigned to a given organization on the Organizations page wherever the name matches. Catalog-style ids already documented elsewhere (buildingType) are kept as the small integers already listed on Filter Options.

Response shape

The response is an array of facet groups, following the same { id, label, children } shape as GET /variable/get-variable-filter-data — but with a different set of facets, scoped to monitored entities rather than variables:

Facet groups returned

This endpoint’s facet set is narrower than GET /variable/get-variable-filter-data (no resourceType, pointType, status, dataReception, or building) and adds one facet variables’ filter data doesn’t have at all: tags. That’s expected, since the two endpoints filter different resources — but it means you can’t assume the two responses share a facet set beyond organizations and buildingType.

The tags facet’s nesting

tags is the only facet with two levels of children. The top-level children aren’t tags themselves — each one is an organization, with its id matching that organization’s id in the organizations facet above (for example, 0c8a44f7 = Oberlin College in both places). Each organization’s own children array is that organization’s actual list of tags, scoped to it — tag definitions (and their ids) belong to one organization and aren’t shared across organizations, even when two organizations happen to use the same tag label (Academic, Administrative, and so on appear under both Oberlin College and Oberlin Schools above, with different ids each time).
Open — not fully decided:
  • Exact encoding for multiple orgIds values (repeated param vs. comma-separated) — same open question as Filter Options.
  • Whether tags is always nested exactly two levels deep, or whether deeper nesting is possible.
  • How (or whether) a selected tags value is meant to be sent back as a filter to a monitored-entity listing endpoint — no such listing endpoint has been documented yet.
See Organizations for valid orgIds values, Monitored Entity List for searching entities with these facets as filters, Get Monitored Entity for retrieving a single entity by id, and Connected Variables for fetching the variables tied to a specific entity.