commit d898115e96c8fb6bdcf5709e82712d4809059390 parent a5cde470028d34e3488daed6d9d9151e4c1553d1 Author: Christian Grothoff <christian@grothoff.org> Date: Thu, 3 Jul 2025 13:16:16 +0200 modify AML statistics endpoint for #10128 Diffstat:
| M | core/api-exchange.rst | | | 24 | ++++++++++++++++++++---- |
1 file changed, 20 insertions(+), 4 deletions(-)
diff --git a/core/api-exchange.rst b/core/api-exchange.rst @@ -5384,14 +5384,18 @@ and freeze or unfreeze accounts suspected of money laundering. fallback: string; } -.. http:get:: /aml/$OFFICER_PUB/kyc-statistics/$NAME +.. http:get:: /aml/$OFFICER_PUB/kyc-statistics/$NAMES - Returns the number of KYC events matching the given event type ``$NAME`` in + Returns the number of KYC events matching the space-separated (!) + list of given event types ``$NAMES`` in the specified time range. Note that this query can be slow as the statistics are computed on-demand. (This is OK as such requests should be rare.) - This endpoint was introduced in protocol **v20**. + This endpoint was introduced in protocol **v20**. It was + modified in **v30** revision 1 to accept a space-separated + list of names instead of a single name and to return an array + of results. **Request:** @@ -5414,16 +5418,28 @@ and freeze or unfreeze accounts suspected of money laundering. **Response:** :http:statuscode:`200 OK`: - The responds will be an `EventCounter` message. + The responds will be an `AmlStatisticsResponse` message. **Details:** + .. ts:def:: AmlStatisticsResponse + + interface AmlStatisticsResponse { + // Statistics that were found. + statistics: EventCounter[]; + } + + .. ts:def:: EventCounter interface EventCounter { + // Name of the statistic that is being returned. + name: String; + // Number of events of the specified type in // the given range. counter: Integer; + }