---
title: "Get Usage Summary"
method: POST
path: "/v1/usage/summary"
tags: ["Authorization"]
---

# Get Usage Summary

`POST /v1/usage/summary`

## Request

- Base URL: `https://api.casparser.in`
- URL: `https://api.casparser.in/v1/usage/summary`
- Auth: API key in header `x-api-key`

Get aggregated usage statistics grouped by feature.

Useful for understanding which API features are being used most and tracking usage trends.

**Legacy path:** `/logs/summary` (still supported)

## Request body

- object
  - `start_time` string, date-time: Start time filter (ISO 8601). Defaults to start of current month.
  - `end_time` string, date-time: End time filter (ISO 8601). Defaults to now.

## Response `200`

Usage summary retrieved successfully

- object
  - `status` string
  - `summary` object
    - `total_credits` number: Total credits consumed in the period
    - `total_requests` integer: Total API requests made in the period
    - `by_feature` object[]: Usage breakdown by feature
      - `feature` string: API feature name
      - `credits` number: Credits consumed by this feature
      - `requests` integer: Number of requests for this feature

## Other responses

- `400`: Bad request (e.g., using access token)
- `401`: Unauthorized. This can happen if the `x-api-key` header is missing.

## Changes

- **2026-09-13** `cf1b57c0f2f7`: 1 warning
  - the optional response header `X-Request-ID` removed for the status `401`
- **2026-07-12** `c74b9ecd5b53`: 1 warning
  - added the new `failed` enum value to the `status` response property for the response status `401`
- **2026-02-22** `be3ca0403f2f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/casparser/apis/cas-parser-track-portfolios-from-cdsl-nsdl-cams-kfintech-2/changes/v1/usage/summary/post.md)

---

[API](https://skmtc.dev/casparser/apis/cas-parser-track-portfolios-from-cdsl-nsdl-cams-kfintech-2.md) - [All operations](https://skmtc.dev/casparser/apis/cas-parser-track-portfolios-from-cdsl-nsdl-cams-kfintech-2/llms.txt) - [OpenAPI document](https://skmtc.dev/casparser/apis/cas-parser-track-portfolios-from-cdsl-nsdl-cams-kfintech-2/revisions/9d8f1445bad3?raw)
