Reports

This-month summary report

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.

get/v1/reports/this-month

Request

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

Query parameters

board_idstring uuid required

The board to report on.

Response

OK

board_idstring uuid required
board_namestring required
board_colorstring

The board color (gradient string); pull the accent from it.

currencystring required
generated_atstring date-time required
day_of_monthinteger required
days_in_monthinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.