Access Points

List participants behind a churn category

The drill-down: the participant IDs behind one churn category count for this Provider over the period, newest observation day first. counterpart narrows a mover category to the participants won from or lost to one Provider. Cursor-paginated in pages of at most 500: follow next_cursor until it is null. A Vendor key (v-<slug>) lists the Vendor's events, also accepts newly_matched and no_longer_matched, and adds counterpart_kind to each item.

get/v1/aps/{key}/churn/participants

Request

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

Path parameters

keystring required

The Provider key, or a Vendor key (v-<slug>).

Query parameters

category'joiner' | 'mover_in' | 'mover_out' | 'leaver' | 'newly_matched' | 'no_longer_matched' required

The churn category to expand. newly_matched and no_longer_matched are valid for a Vendor key only; with a Provider key they are a 400.

fromstring date

Inclusive period start, YYYY-MM-DD UTC.

tostring date

Inclusive period end, YYYY-MM-DD UTC.

counterpartstring

Filter to one counterpart Provider key: the Provider the participants were won from (mover_in) or lost to (mover_out). Allowed with the two mover categories only. For a Vendor key the counterpart can also be a Vendor key. An unknown key returns an empty list.

limitinteger

Page size, clamped to [1, 500]. Defaults to 500 (20 through MCP).

cursorstring

Opaque pagination cursor returned as next_cursor by the previous page.

Response

The participants in that category.

next_cursorstring nullable required

Opaque cursor for the next page, or null on the last page.

Changes

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