Skip to content
This repository was archived by the owner on Aug 9, 2023. It is now read-only.

Releases: RtStats/FrontAPI

Release v1.0.1

14 Aug 20:19

Choose a tag to compare

Thrift APIs:

  • ping
  • version
  • tadd + onewayAdd
  • tset + onewaySet
  • ttag + onewayTag
  • tuntag + onewayUntag

REST APIs:
** API: /api/ping **

  • No-op, just to test if server is available.

** API: /api/version **

  • Return API server's version information.
  • Parameters: none

** API: /api/add **

  • Add value to a counter.
  • Parameters:
    • authkey: [String] authentication key for server to authenticate the client (not used yet).
    • c: [String] counter name.
    • v: (optional)[Long] value to add, default value is 1.
    • t: (optional)[Long] UNIX-timestamp (in millisec) to add, default value is current timestamp at server.

** API: /api/set **

  • Set value to a counter.
  • Parameters:
    • authkey: [String] authentication key for server to authenticate the client (not used yet).
    • c: [String] counter name.
    • v: [Long] value to add.
    • t: (optional)[Long] UNIX-timestamp (in millisec) to add, default value is current timestamp at server.

** API: /api/tag **

  • Tag a counter.
  • Parameters:
    • authkey: [String] authentication key for server to authenticate the client (not used yet).
    • c: [String] counter name.
    • tags: [Array of String] list of tag names.

** API: /api/untag **

  • Untag a counter.
  • Parameters:
    • authkey: [String] authentication key for server to authenticate the client (not used yet).
    • c: [String] counter name.
    • tags: [Array of String] list of tag names.