Participants

Get a filtered participant breakdown

The participant set broken down by country, entity type, NACE Rev. 2.1 division, size class, region and serving Access Point, over a FILTERED slice — so a breakdown stays true while the list is cut down. The filters are the same names and shapes as GET /v1/participants.

TWO SOURCES, one shape, named by source. A request that narrows on NOTHING is answered from the hourly rollup (source: "rollup", with refreshed_at) — the whole-network breakdown, no scan. A request that narrows is computed live (source: "slice").

BOUNDED BY DESIGN. A live slice is computed only while it is narrow (under an internal cap of 10,000 participants). A slice wider than the cap, or a request carrying a filter this endpoint cannot express (doctype, transport_profile, q, host, sub_provider), answers degraded: true with every mix null — never a wrong number and never an error. Callers fall back to the whole-network breakdown on GET /v1/stats/participants.

Counts are sparse the same way the rollup facets 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. ap_mix names the busiest Access Point Seats and folds the rest into one __other__ bucket.

get/v1/participants/mix

Request

  • Base URL: https://api.peppolstatus.com
  • URL: https://api.peppolstatus.com/v1/participants/mix
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Query parameters

countrystring[]

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 country_mix buckets on.

schemestring[]

Comma-array of Peppol identifier schemes.

smpstring[]

Comma-array of current SMP hostnames (smp1.example,smp2.example).

apstring[]

Comma-array of serving Access Point SeatIDs (PBE000123,PNO000456).

registeredboolean

Filter by current SML registration state.

provenancestring[]

Comma-array of provenance values.

entity_typestring[]

Comma-array of company legal-form families (company,natural_person,association,public), from the company-register enrichment denormalized onto the participant.

sectorstring[]

Comma-array of 2-digit NACE Rev. 2.1 divisions (47,62).

sizestring[]

Comma-array of company size band codes, as stored (12,21): the INSEE trancheEffectifs codes for FR (NN = unknown), and for NO the same code set plus 1-4.

regionstring[]

Comma-array of company seat region codes (BE-BRU,BE-VLG).

postcodestring[]

Comma-array of company seat postcodes.

vat_liableboolean

Filter by company VAT-liable / mandate-scope flag.

not_countrystring[]

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&not_region=NO-32 applies both.

not_smpstring[]

Comma-array of SMP hostnames 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&not_region=NO-32 applies both.

not_entity_typestring[]

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&not_region=NO-32 applies both.

not_sectorstring[]

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&not_region=NO-32 applies both.

not_sizestring[]

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&not_region=NO-32 applies both.

not_regionstring[]

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&not_region=NO-32 applies both.

Response

The filtered participant breakdowns, the whole-network rollup when nothing was narrowed, or a degraded answer when they cannot be computed honestly.

source'slice' | 'rollup' required

Which population the numbers describe: slice when the request narrowed and the breakdowns were computed live, rollup when it narrowed on nothing and the hourly whole-network facets answered. Callers should show it.

degradedboolean required

True when the breakdowns could not be computed honestly — the request carried a filter this endpoint cannot express, or selected a slice wider than the internal cap. Every mix and the count are then null and the caller falls back to the whole-network breakdown on GET /v1/stats/participants.

participant_countinteger nullable required

Exact size of the population the mixes describe (not an estimate, not capped). On source: "rollup" this is the rollup's total_count. Null when degraded.

refreshed_atstring date-time nullable required

When the rollup behind a source: "rollup" answer was last built. Null on a live slice and when degraded.

Changes

No recorded changes to this operation across all 1 revision of this API.