get-monitoring-closure-lags.rst (1579B)
1 .. http:get:: /monitoring/closure-lags 2 3 Get a list of closure lags stored by the auditor. 4 5 The following query parameters are optional, and can be used to customise the response: 6 7 **Request:** 8 9 :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. 10 :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. 11 :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. 12 13 14 With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed. 15 16 **Response:** 17 18 :http:statuscode:`200 OK`: 19 The auditor responds with a top level array of :ts:type:`ClosureLags` objects. If no elements could be found, an empty array is returned 20 21 22 23 **Details:** 24 25 .. ts:def:: ClosureLags 26 27 interface ClosureLags { 28 29 // Unique row identifier 30 row_id : Integer; 31 32 // Amount of money left in the reserve 33 amount : Amount; 34 35 // When should the reserve have been closed 36 deadline : Timestamp; 37 38 // The wire transfer identifier 39 wtid : HashCode; 40 41 // Full payto:// URI (RFC 8905) of the account that 42 // should have been credited. 43 account : string; 44 45 // True if this diagnostic was suppressed. 46 suppressed : boolean; 47 48 } 49 50 .. note:: 51 52 This endpoint is still experimental. The endpoint will be further developed as needed.