Seats

Get a seat's compliance scorecard

One seat's compliance posture: the registrations under it, its OPEN findings broken down by rule, the daily trend, and where the seat sits against the network. This is what a Peppol Authority's periodic scan reports, from the same published rules (GET /v1/compliance/rules), before the letter arrives.

Rates are open findings per 1,000 registrations, and null when the seat hosts no registrations. The network median and 90th percentile are taken over every seat that hosts registrations — a seat with no finding of a rule counts as 0 — so they describe the whole network, not only the seats that break the rule.

Read from a daily rollup: snapshot_date is the day it describes, and is null (with zero counts and empty lists) for a seat no scan has covered yet.

get/v1/seats/{seatId}/compliance

Request

  • Base URL: https://api.peppolstatus.com
  • URL: https://api.peppolstatus.com/v1/seats/{seatId}/compliance
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

seatIdstring required

The seat identifier (e.g. POP000748).

Query parameters

daysinteger

How many daily snapshots the trend covers (default 90).

Response

The seat's compliance scorecard.

seat_idstring required
snapshot_datestring date nullable required

The day the card describes; null when no scan has covered the seat.

computed_atstring date-time nullable required
registrationsinteger required

Registrations whose access point is this seat.

open_findingsinteger required
open_per_1knumber nullable required
network_median_open_per_1knumber nullable required
network_p90_open_per_1knumber nullable required
peer_seat_countinteger required

Changes

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