FOformancehq
Numscript Library

Get template usage

Changed on

Returns the invocation counter and last-used timestamp for a Numscript template. Values are materialised asynchronously by the usagebuilder subsystem from the FSM audit chain and may lag the live FSM while the worker drains pending batches. A never-invoked template returns a zero-valued response (not 404), so clients handle "never used" uniformly.

get/v3/{ledgerName}/numscripts/{name}/usage

Request

  • Base URL
    http://localhost:9000
  • URL
    http://localhost:9000/v3/{ledgerName}/numscripts/{name}/usage
  • Auth
    • HTTP bearer
    • or none

Path parameters

ledgerNamestring required

Name of the ledger

namestring required

Name of the numscript template, URL-encoded as one path segment. Decoded exactly once.

Headers

X-Consistency'linearizable' | 'stale'

Read consistency. linearizable (the default) runs a Raft ReadIndex barrier and waits for the receiving node to apply up to it. stale serves the read from the receiving node's own store, with no barrier and no forwarding to the leader, so the answer may lag the leader. Matching ignores case and surrounding whitespace. An unknown value, or a repeated or comma-joined header, returns 400 INVALID_REQUEST on every /v3 route, writes included; a valid value has no effect on writes. The gRPC equivalent is the x-consistency request metadata.

Response

Template usage retrieved successfully

Changes

  • f5e817eca038Revision changes
    • info

      api operation id getNumscriptUsage removed and replaced with v3GetNumscriptUsage

  • 3da23d327316Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status