Get AI assistant usage for a month

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/ai-chat/usage.do

Lists, per user and key source, the AI assistant chat's model calls in one calendar month (UTC): calls, input, output, cache-read and cache-write tokens, the raw Claude API cost at list prices (rawCostUsd) and the cost the network is billed (billedCostUsd = raw x multiplier on Epom's key, 0 on the user's or the network's own key), what the AI assistant promo waived (promoWaivedUsd: the would-be billed amount of calls billed 0 during the promo), with the effective monthly cap (limitUsd: the user's own cap, else the network default, else on Epom's key the platform default; null = no cap). keySource is user, network or epom. Users without calls that month are left out. promoUntil is the last day (UTC) of the network's promo, null when none runs; promoAllowanceUsd is the would-be billed USD it waives for the whole network (null = no cap). The figures belong with Epom's invoice to the network, so this requires the Ad Server Fees admin permission (AD_SERVER_FEES or AD_SERVER_FEES_MANAGEMENT) - the same as the AI assistant usage section of the Ad Server Fees page. Read-only.

Query Params

month string

Calendar month (UTC) in YYYY-MM form; the current month when omitted

2026-10

Responses

200

{success, month, rows:[{userId, username, keySource, calls, inputTokens, outputTokens, cacheReadTokens, cacheWriteTokens, rawCostUsd, billedCostUsd, promoWaivedUsd, limitUsd}], totalRawUsd, totalBilledUsd, totalPromoWaivedUsd, multiplier, promoUntil, promoAllowanceUsd}

400

month is not in YYYY-MM form

401

Authentication error

403

Neither AD_SERVER_FEES nor AD_SERVER_FEES_MANAGEMENT

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/ai-chat/usage.do?month=2026-10' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/ai-chat/usage.do?month=2026-10", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/ai-chat/usage.do?month=2026-10', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/ai-chat/usage.do?month=2026-10"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/ai-chat/usage.do?month=2026-10");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/ai-chat/usage.do?month=2026-10", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/ai-chat/usage.do?month=2026-10");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/ai-chat/usage.do?month=2026-10")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body