Get usage summary

GET /v1/usage

Month-to-date usage for your current team across every endpoint.

The summary reports the operation counts, the bytes saved (input bytes minus output bytes), and the average per-image size reduction. It covers the current calendar month, and the window is echoed in data.period.

Failed requests count toward the operation totals, but never toward the savings.

GET Request

php

use MathiasGrimm\GlimpsePhp\Glimpse;

$glimpse = Glimpse::createClient('YOUR_TOKEN');

$usage = $glimpse->usage();
// month-to-date operations, bytes saved, average reduction

javascript

const response = await fetch("https://glimpseimg.test/api/v1/usage", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
  },
});

python

import requests

response = requests.get(
    "https://glimpseimg.test/api/v1/usage",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
    },
)

ruby

require "net/http"
require "json"
require "uri"

uri = URI("https://glimpseimg.test/api/v1/usage")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"
request["Accept"] = "application/json"

response = http.request(request)

200 Response

php

// $usage is a MathiasGrimm\GlimpsePhp\UsageSummary
$usage->operations;       // 1284
$usage->bytesSaved;       // 401238912
$usage->averageReduction; // 71
$usage->byOperation;      // ['convert' => 812, 'optimize' => 305, ...]
$usage->period->from;     // DateTimeImmutable, start of the month

json

{
  "data": {
    "period": {
      "from": "2026-07-01T00:00:00+00:00",
      "to": "2026-07-31T23:59:59+00:00"
    },
    "operations": 1284,
    "bytes_saved": 401238912,
    "average_reduction": 71,
    "by_operation": {
      "convert": 812,
      "optimize": 305,
      "resize": 98,
      "thumbnail": 41,
      "info": 19,
      "analyze": 9
    }
  }
}

json

{
  "data": {
    "period": {
      "from": "2026-07-01T00:00:00+00:00",
      "to": "2026-07-31T23:59:59+00:00"
    },
    "operations": 1284,
    "bytes_saved": 401238912,
    "average_reduction": 71,
    "by_operation": {
      "convert": 812,
      "optimize": 305,
      "resize": 98,
      "thumbnail": 41,
      "info": 19,
      "analyze": 9
    }
  }
}

json

{
  "data": {
    "period": {
      "from": "2026-07-01T00:00:00+00:00",
      "to": "2026-07-31T23:59:59+00:00"
    },
    "operations": 1284,
    "bytes_saved": 401238912,
    "average_reduction": 71,
    "by_operation": {
      "convert": 812,
      "optimize": 305,
      "resize": 98,
      "thumbnail": 41,
      "info": 19,
      "analyze": 9
    }
  }
}

json

{
  "data": {
    "period": {
      "from": "2026-07-01T00:00:00+00:00",
      "to": "2026-07-31T23:59:59+00:00"
    },
    "operations": 1284,
    "bytes_saved": 401238912,
    "average_reduction": 71,
    "by_operation": {
      "convert": 812,
      "optimize": 305,
      "resize": 98,
      "thumbnail": 41,
      "info": 19,
      "analyze": 9
    }
  }
}

json

{
  "data": {
    "period": {
      "from": "2026-07-01T00:00:00+00:00",
      "to": "2026-07-31T23:59:59+00:00"
    },
    "operations": 1284,
    "bytes_saved": 401238912,
    "average_reduction": 71,
    "by_operation": {
      "convert": 812,
      "optimize": 305,
      "resize": 98,
      "thumbnail": 41,
      "info": 19,
      "analyze": 9
    }
  }
}

Responses

200

UsageSummaryResource

application/json

object

data object Required
- period object Required
  
  from string Required
  
  to string Required
- operations string Required
- bytes_saved string Required
- average_reduction string Required
- by_operation string Required

401

Unauthenticated

application/json

object

message string Required

Error overview.