> For the complete documentation index, see [llms.txt](https://docs.gobtcpay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gobtcpay.com/api-reference/merchant-api/dashboard.md).

# Dashboard

Aggregated home-screen summary: balance, today's metrics, the 7-day chart, and recent payments in a single call.

## Dashboard summary

> Returns everything the home screen needs in one call: BTC / fiat \`balance\`, today's volume and transaction metrics (with day-over-day deltas), the 7-day \`chart7d\`, and the most \`recent\` payments.

```json
{"openapi":"3.1.0","info":{"title":"GoBTC Pay Merchant Account API","version":"1.45.2"},"tags":[{"name":"Dashboard","description":"Aggregated home-screen summary: balance, today's metrics, the 7-day chart, and recent payments in a single call."}],"servers":[{"url":"https://api.gobtcpay.com/public/api/v1.1"}],"security":[{"merchantAuth":[]}],"components":{"securitySchemes":{"merchantAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Merchant dashboard access token obtained from `/merchant/auth/login` (or the OAuth / passkey / 2FA login flows). Send it as `Authorization: Bearer <accessToken>`. Refresh it via `/merchant/auth/refresh` when it expires."}}},"paths":{"/merchant/dashboard/summary":{"post":{"summary":"Dashboard summary","description":"Returns everything the home screen needs in one call: BTC / fiat `balance`, today's volume and transaction metrics (with day-over-day deltas), the 7-day `chart7d`, and the most `recent` payments.","tags":["Dashboard"],"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"result":{"type":"object","properties":{"$case":{"type":"string","const":"success"},"success":{"type":"object","properties":{"businessName":{"type":"string"},"balanceBtc":{"type":"number"},"balanceUsd":{"type":"number"},"btcUsdRate":{"type":"number"},"today":{"type":"object","properties":{"volumeBtc":{"type":"number"},"volumeUsd":{"type":"number"},"txCount":{"type":"number"},"deltaVolumePct":{"type":"number"},"deltaTxCount":{"type":"number"},"pendingBtc":{"type":"number"},"pendingUsd":{"type":"number"}},"required":["volumeBtc","volumeUsd","txCount","deltaVolumePct","deltaTxCount","pendingBtc","pendingUsd"],"additionalProperties":false},"chart7d":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"vol":{"type":"number"},"count":{"type":"number"}},"required":["day","vol","count"],"additionalProperties":false}},"recent":{"type":"array","items":{"type":"object","properties":{"time":{"type":"string"},"amountBtc":{"type":"number"},"amountUsd":{"type":"number"},"status":{"type":"string","enum":["confirmed","pending","failed"],"description":"Current status. Payments: `initiated` / `paid` / `failed` / `expired` / `canceled` / `cleared`. Payment transactions: `success` / `failed` / `pending` / `cleared`."},"ref":{"type":"string"}},"required":["time","amountBtc","amountUsd","status","ref"],"additionalProperties":false}}},"required":["businessName","balanceBtc","balanceUsd","btcUsdRate","today","chart7d","recent"],"additionalProperties":false}},"required":["$case","success"],"additionalProperties":false}},"required":["id","result"],"additionalProperties":false,"$schema":"http://json-schema.org/draft-07/schema#"}}}},"500":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"statusCode":{"type":"number","description":"Numeric error status code."},"description":{"type":"string","description":"Human-readable description."},"statusMessage":{"type":"string","description":"Short machine-readable error message."}},"required":["statusCode","description","statusMessage"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"$schema":"http://json-schema.org/draft-07/schema#"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.gobtcpay.com/api-reference/merchant-api/dashboard.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.