taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

get-monitoring-historic-denomination-revenue.rst (1670B)


      1 .. http:get:: /monitoring/historic-denomination-revenue
      2 
      3   Get a list of historic denomination revenue 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 
     12   With the default settings, the endpoint returns at most the 20 latest elements.
     13 
     14   **Response:**
     15 
     16   :http:statuscode:`200 OK`:
     17     The auditor responds with a top level array of :ts:type:`HistoricDenominationRevenue` objects. If no elements could be found, an empty array is returned
     18 
     19   **Details:**
     20 
     21   .. ts:def:: HistoricDenominationRevenue
     22 
     23     interface HistoricDenominationRevenue {
     24 
     25       // Unique row identifier
     26       row_id : Integer;
     27 
     28       // Hash code of the denomination public key involved
     29       denom_pub_hash : HashCode;
     30 
     31       // Time when the denomination expired and thus the revenue
     32       // was computed.
     33       revenue_timestamp : Timestamp;
     34 
     35       // Total fee revenue the exchange earned from coins of this
     36       // denomination.
     37       revenue_balance : Amount;
     38 
     39       // Total losses the exchange experienced from this denomination
     40       // (this basically only happens if someone was able to forge
     41       // denomination signatures). So non-zero values are indicative
     42       // of a serious problem.
     43       loss_balance : Amount;
     44 
     45     }
     46 
     47   .. note::
     48 
     49     This endpoint is still experimental. The endpoint will be further developed as needed.