taler-docs

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

get-monitoring-progress.rst (683B)

      1 .. http:get:: /monitoring/progress
      2 
      3   Get the progress stored by the auditor.
      4 
      5   **Request:**
      6 
      7   :query progress_key: a string identifying a progress point. If specified, only returns the element with this exact key. The default value is NULL.
      8 
      9 
     10   **Response:**
     11 
     12   :http:statuscode:`200 OK`:
     13     The auditor responds with a top level array of :ts:type:`Progress` objects. If no elements could be found, an empty array is returned
     14 
     15   **Details:**
     16 
     17   .. ts:def:: Progress
     18 
     19     interface Progress {
     20 
     21       // Key associated with a given progress point
     22       progress_key: string;
     23 
     24       // How much of the exchanges data has been processed so far
     25       progress_offset: Integer;
     26 
     27     }