taler-docs

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

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

      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   :http:statuscode:`400 Bad request`:
     19     The request is malformed. Returned with an
     20     ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code.
     21   :http:statuscode:`401 Unauthorized`:
     22     The request lacks valid authentication credentials.
     23     The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``.
     24   :http:statuscode:`500 Internal Server Error`:
     25     The server experienced an internal error.
     26     The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED`` or
     27     ``TALER_EC_GENERIC_DB_FETCH_FAILED`` error code.
     28 
     29   **Details:**
     30 
     31   .. ts:def:: HistoricDenominationRevenue
     32 
     33     interface HistoricDenominationRevenue {
     34 
     35       // Unique row identifier
     36       row_id : Integer;
     37 
     38       // Hash code of the denomination public key involved
     39       denom_pub_hash : HashCode;
     40 
     41       // Time when the denomination expired and thus the revenue
     42       // was computed.
     43       revenue_timestamp : Timestamp;
     44 
     45       // Total fee revenue the exchange earned from coins of this
     46       // denomination.
     47       revenue_balance : Amount;
     48 
     49       // Total losses the exchange experienced from this denomination
     50       // (this basically only happens if someone was able to forge
     51       // denomination signatures). So non-zero values are indicative
     52       // of a serious problem.
     53       loss_balance : Amount;
     54 
     55     }
     56 
     57   .. note::
     58 
     59     This endpoint is still experimental. The endpoint will be further developed as needed.