---
title: "Get summary statistics for proxy usage"
method: POST
path: "/v1/proxy/analytics/summary"
tags: ["Analytics"]
---

# Get summary statistics for proxy usage

`POST /v1/proxy/analytics/summary`

## Request

- Base URL: `https://api.platform.soax.com`
- URL: `https://api.platform.soax.com/v1/proxy/analytics/summary`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/soax/apis/soax-api/docs/v1/proxy/analytics/summary/post.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve aggregate credits burned and traffic (GB) for the selected date range, compared against the previous period of the same length (`previous_period.to_date` is the day before `from_date`). If the API key is restricted to specific packages, only those packages are included. The date range may span at most 365 days.

Requires the `proxy:analytics:read` scope.

## Request body

- SummaryRequest: Request model for summary statistics query.
  - `from_date` string, date-time, required: Start date for the query range
  - `to_date` string, date-time, required: End date for the query range. At most 365 days after `from_date`.

## Response `200`

Successful Response

- SummaryResponse: Response schema for summary endpoint.
  - `selected_period` PeriodSummary, required: Summary data for a single period.
    - `from_date` string, date-time, required: Start date of the period
    - `to_date` string, date-time, required: End date of the period
    - `credits_burned` number, required: Total credits burned in the period
    - `traffic_gb` number, required: Total traffic spent in GB
  - `previous_period` PeriodSummary, required: Summary data for a single period.
    - `from_date` string, date-time, required: Start date of the period
    - `to_date` string, date-time, required: End date of the period
    - `credits_burned` number, required: Total credits burned in the period
    - `traffic_gb` number, required: Total traffic spent in GB

## Other responses

- `400`: A parameter value or combination is invalid. Service-level validation errors use the `error` key; endpoint-level checks use `detail`. Read `detail ?? error`.
- `401`: Missing, invalid, or revoked API key.
- `403`: The API key does not carry the scope this endpoint requires.
- `422`: Validation Error
- `429`: Rate limit exceeded (5 requests/second per API key, 500 requests/minute per IP). The response includes `Retry-After` (seconds), `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` (Unix time) headers — wait `Retry-After` seconds and retry.

---

[API](https://skmtc.dev/soax/apis/soax-api.md) - [All operations](https://skmtc.dev/soax/apis/soax-api/llms.txt) - [OpenAPI document](https://skmtc.dev/soax/apis/soax-api/revisions/2abdaa934277?raw)