---
title: "check budget status"
method: POST
path: "/v2/metrics/budget:status"
tags: ["Metrics"]
---

# check budget status

`POST /v2/metrics/budget:status`

## Request

- Base URL: `https://your-subdomain.deputy.deputy.com/api`
- URL: `https://your-subdomain.deputy.deputy.com/api/v2/metrics/budget:status`
- Auth: API key in header `OAuth`

check budget status.

## Request body

- MetricsBudgetStatusRequest
  - `start` string, int64
  - `end` string, int64
  - `areas` integer[]

## Response `200`

A successful response.

- MetricsBudgetStatusResponse
  - `success` boolean
  - `type` string
  - `data` ModelBudgetStatusResponseData[]
    - `date` string
    - `budget` number, double
    - `status` 'WITHIN_BUDGET' | 'OVER_BUDGET'

---

[API](https://skmtc.dev/deputy/apis/deputy-v2-api.md) - [All operations](https://skmtc.dev/deputy/apis/deputy-v2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/deputy/apis/deputy-v2-api/revisions/78f0278f4608?raw)