---
title: "Analytics Breakdown"
method: GET
path: "/public/user/analytics/breakdown"
tags: ["Proxy Analytics"]
---

# Analytics Breakdown

`GET /public/user/analytics/breakdown`

This endpoint analyzes proxy usage for a given customer within a specified time range
and provides breakdowns by proxy users, hostnames, and network types.

You can either:

1. Provide a "preset" parameter, which automatically sets the time period
   (e.g. "last_day", "last_hour", etc.).
2. OR, manually specify your own time range using period_start and period_end.

You can also filter by hostname, network, and proxy_user_id.
Hostname filters are disallowed if searching older than 90 days.

## Query parameters

- `preset` string
- `period_start` string, datetime
- `period_end` string, datetime
- `hostname` string
- `network` 'datacenter' | 'isp' | 'residential' | 'mobile'
- `proxy_user_id` string
- `return_proxy_users` boolean
- `return_hostnames` boolean
- `return_networks` boolean
- `sort_by` string
- `limit` string

## Response `200`

Analytics breakdown successful.

- object
  - `data` object
    - `hostnames` object[] — Breakdown by hostnames (if return_hostnames=true)
      - `bytes` integer — Total bytes transferred for this hostname
      - `hostname` string — The hostname requested
      - `requests` integer — Total number of requests to this hostname
    - `networks` object[] — Breakdown by network types (if return_networks=true)
      - `bytes` integer — Total bytes transferred through this network
      - `network` 'datacenter' | 'isp' | 'residential' | 'mobile' — Type of network
      - `requests` integer — Total number of requests made through this network
    - `proxy_user_ids` object[] — Breakdown by proxy users (if return_proxy_users=true)
      - `bytes` integer — Total bytes transferred by this proxy user
      - `proxy_user_id` string — ID of the proxy user
      - `requests` integer — Total number of requests made by this proxy user
    - `total_bytes` integer — Total number of requests in time period
    - `total_requests` integer — Total number of requests in time period
  - `message` string

---

[API](https://skmtc.dev/byteful/apis/byteful-public-user-api.md) · [All operations](https://skmtc.dev/byteful/apis/byteful-public-user-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/byteful/byteful-public-user-api/revisions/3db1a6fc0099/schema)