Transfer Stats

This document describes the stats endpoint within the transfer module, providing data on the quantity of bytes your provider devices have transferred.

GET /transfer/stats

Retrieve global transfer statistics for the authenticated network, broken down by payment status.

Request

GET /transfer/stats

Headers:

{
  "Host": "api.bringyour.com",
  "Authorization": "Bearer YOUR_JWT_TOKEN",
  "Accept": "application/json"
}

Response

200 Success

Status: 200 OK

Content-Type: application/json

A successful response returns a breakdown of the data your devices have provided.

{
  "paid_bytes_provided": 1073741824,
  "unpaid_bytes_provided": 536870912
}

Example

HTTP Request

GET /transfer/stats HTTP/1.1
Host: api.bringyour.com
Authorization: Bearer YOUR_JWT_TOKEN
Accept: application/json

Successful HTTP Response

{
  "paid_bytes_provided": 1073741824,
  "unpaid_bytes_provided": 536870912
}