Bunnyx.Statistics (Bunnyx v0.3.0)

Copy Markdown View Source

Account-wide statistics — bandwidth, cache hit rates, requests, origin traffic, and error breakdowns.

This is distinct from per-resource statistics on PullZone, StorageZone, and DnsZone.

Uses the main API client created with Bunnyx.new/1.

Usage

client = Bunnyx.new(api_key: "sk-...")

{:ok, stats} = Bunnyx.Statistics.get(client,
  date_from: "2025-06-01T00:00:00Z",
  date_to: "2025-06-30T23:59:59Z"
)

Summary

Functions

Returns account-wide statistics.

Functions

get(client, opts \\ [])

@spec get(
  Bunnyx.t() | keyword(),
  keyword()
) :: {:ok, map()} | {:error, Bunnyx.Error.t()}

Returns account-wide statistics.

Options

  • :date_from — start date (ISO 8601 string)
  • :date_to — end date (ISO 8601 string)
  • :pull_zone — filter by pull zone ID
  • :server_zone_id — filter by server zone / region ID
  • :hourly — group by hour instead of day
  • :load_errors — include 3xx/4xx/5xx error charts
  • :load_origin_response_times — include origin response time chart
  • :load_origin_traffic — include origin traffic chart
  • :load_requests_served — include requests served chart
  • :load_bandwidth_used — include bandwidth used chart
  • :load_origin_shield_bandwidth — include origin shield bandwidth chart
  • :load_geographic_traffic_distribution — include geo traffic distribution
  • :load_user_balance_history — include user balance history chart