Add method /usage-stats to rt.yml

tonkeeper · Nov 8, 2024 · a0f9f5a · a0f9f5a
1 parent b44009d
commit a0f9f5a
Showing 1 changed file with 37 additions and 0 deletions.
diff --git a/api/rt.yml b/api/rt.yml
@@ -104,6 +104,20 @@ paths:
                 example: { }
         'default':
           $ref: '#/components/responses/Error'
+  /usage-stats:
+    get:
+      operationId: getUsageStats
+      parameters:
+        - $ref: '#/components/parameters/tokenQuery'
+      responses:
+        '200':
+          description: "usage stats"
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UsageStats'
+        'default':
+          $ref: '#/components/responses/Error'
   /webhooks/{webhook_id}/account-tx/subscribe:
     post:
       description: "subscribe to notifications for a particular set of accounts"
@@ -373,6 +387,29 @@ components:
         error:
           type: string
           example: error description
+    UsageStats:
+      type: object
+      required:
+        - period_started_at
+        - account_subscriptions
+        - webhooks_delivered
+        - webhooks_failed
+      properties:
+        period_started_at:
+          type: string
+          format: date-time
+        period_ended_at:
+          type: string
+          format: date-time
+        account_subscriptions:
+          type: integer
+          format: int64
+        webhooks_delivered:
+          type: integer
+          format: int64
+        webhooks_failed:
+          type: integer
+          format: int64
     WebhookList:
       type: object
       required: