---
title: "This-month summary report"
method: GET
path: "/v1/reports/this-month"
tags: ["Reports"]
---

# This-month summary report

`GET /v1/reports/this-month`

## Request

- Base URL: `https://app.getdealboard.com`
- URL: `https://app.getdealboard.com/v1/reports/this-month`
- Auth: HTTP bearer

The "This Month So Far" snapshot for a board: three metrics — proposals (deals that reached the anchor stage this month), deals won, and deal value (cents) — each against its monthly goal with a pace verdict (`ahead` | `on-track` | `behind`, or null if no goal is set), plus day-of-month and the active-deal pipeline. Powers the iPhone home-screen widget.

## Query parameters

- `board_id` string, uuid, required

## Response `200`

OK

- object
  - `board_id` string, uuid, required
  - `board_name` string, required
  - `board_color` string: The board color (gradient string); pull the accent from it.
  - `currency` string, required
  - `generated_at` string, date-time, required
  - `day_of_month` integer, required
  - `days_in_month` integer, required
  - `metrics` object[], required
    - `key` 'proposals' | 'deals_won' | 'deal_value'
    - `label` string
    - `current` integer: Count for proposals/deals_won; cents for deal_value.
    - `goal` integer, nullable
    - `pace` 'ahead' | 'on-track' | 'behind', nullable
  - `pipeline` object[], required
    - `stage_id` string
    - `name` string
    - `region` string
    - `deal_count` integer

## Other responses

- `400`: `board_id` is required.
- `401`: Missing or invalid credential.
- `404`: Board not found in your workspace.

---

[API](https://skmtc.dev/getdealboard/apis/dealboard-api.md) · [All operations](https://skmtc.dev/getdealboard/apis/dealboard-api/llms.txt) · [OpenAPI document](https://skmtc.dev/getdealboard/apis/dealboard-api/revisions/4066bf9d265e?raw)