get_access_point_roster_mix
Get a filtered access point roster breakdown
The five roster breakdowns of GET /v1/aps/{key} (country, entity type, NACE Rev. 2.1 division, size class, region) recomputed over a FILTERED slice of the roster, so a breakdown stays true while the roster is cut down. The filters are the same names and shapes as GET /v1/participants, scoped to this provider's seats.
BOUNDED BY DESIGN. The breakdowns are computed only when the filtered slice is narrow (under an internal cap of 10,000 participants). A request that narrows on nothing, that carries a filter this endpoint cannot express (doctype, transport_profile, q, host, sub_provider, postcode, provenance, vat_liable), or whose slice is too wide answers degraded: true with every mix null — never a wrong number and never an error. Callers fall back to the stored whole-roster mixes on GET /v1/aps/{key}.
Counts are sparse the same way the stored mixes are: company enrichment covers a handful of registers, so every mix except country_mix sums BELOW participant_count and the un-enriched remainder is derived from the total rather than served as a bucket.
A Vendor key (v-<slug>) answers the same question over the Vendor's roster and needs a Market-tier key. seat then selects one Seat the Vendor connects through.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | The provider key (e.g. `c-tickstar`, `o-teamleader-nv-1f3a2b9c`), or a Vendor key (`v-exact`). | |
| smp | No | Comma-array of SMP hostnames serving the participant. | |
| seat | No | Scope the slice to ONE member seat of this provider. A seat that is not a member answers an empty (not degraded) slice. Single-valued. | |
| size | No | Comma-array of company size classes (as stored). | |
| region | No | Comma-array of company seat region codes (`NO-32,BE-BRU`). | |
| scheme | No | Comma-array of Peppol identifier schemes. | |
| sector | No | Comma-array of 2-digit NACE Rev. 2.1 divisions (`47,62`). | |
| country | No | Comma-array of ISO-3166-1 alpha-2 country codes. Matched on the participant's card country, falling back to the country its ICD prefix implies — the same rule the stored `country_mix` buckets on. | |
| not_size | No | Comma-array of company size band codes (as stored: `21,NN`; FR and NO only) to EXCLUDE. Rows with no value are KEPT — excluding a value never drops the un-enriched remainder. Combines with its include twin: `?region=NO-03¬_region=NO-32` applies both. | |
| not_region | No | Comma-array of company seat region codes (`NO-32,BE-BRU`) to EXCLUDE. Rows with no value are KEPT — excluding a value never drops the un-enriched remainder. Combines with its include twin: `?region=NO-03¬_region=NO-32` applies both. | |
| not_sector | No | Comma-array of 2-digit NACE Rev. 2.1 divisions (`47,62`) to EXCLUDE. Rows with no value are KEPT — excluding a value never drops the un-enriched remainder. Combines with its include twin: `?region=NO-03¬_region=NO-32` applies both. | |
| registered | No | Restrict to participants present (`true`) or absent (`false`) in the Peppol Directory. | |
| entity_type | No | Comma-array of company legal-form families (`company`, `natural_person`, `association`, `public`). | |
| not_country | No | Comma-array of country codes (`NO,SE`) to EXCLUDE. Rows with no value are KEPT — excluding a value never drops the un-enriched remainder. Combines with its include twin: `?region=NO-03¬_region=NO-32` applies both. | |
| not_entity_type | No | Comma-array of company legal-form families (`company`,`natural_person`,`association`,`public`) to EXCLUDE. Rows with no value are KEPT — excluding a value never drops the un-enriched remainder. Combines with its include twin: `?region=NO-03¬_region=NO-32` applies both. |