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

# Dashboard

Get a consolidated summary of report data for the dashboard page. This endpoint returns report volume, report history, recent crashes, status counts, and top report groups a single request.

## Dashboard Summary

<mark style="color:blue;">`GET`</mark> `https://app.bugsplat.com/api/dashboard`

Returns a consolidated dashboard summary for the specified database and time range, including report volume, report history chart data, recent reports, status counts, and top report groups. Reports are counted as they are ingested and may have occurred on different dates (e.g. sent at next launch). For accurate accounting of reports by date please use the [Crashes](/api-reference/api/crashes.md) endpoint or [webhook](/guides/integrating-with-tools/messanger-apps/webhook.md).

#### Query Parameters

| Name        | Type   | Description                                                                                            |
| ----------- | ------ | ------------------------------------------------------------------------------------------------------ |
| database    | string | **Required.** BugSplat database name                                                                   |
| startDate   | string | ISO 8601 timestamp for the start of the time range. If omitted, defaults to 365 days before `endDate`. |
| endDate     | string | ISO 8601 timestamp for the end of the time range. If omitted, defaults to the current time.            |
| appNames    | string | Comma-separated list of application names to filter by                                                 |
| appVersions | string | Comma-separated list of application versions to filter by                                              |
| timezone    | string | UTC offset (e.g. `+05:30`). Defaults to `+00:00`                                                       |
| interval    | string | `hourly` or `daily`. Defaults to `daily`                                                               |

{% tabs %}
{% tab title="200 " %}

```json
{
    "status": "success",
    "database": "Fred",
    "volume30Day": 1234,
    "uploaded30Day": 1100,
    "crashDataDays": 45,
    "crashHistory": {
        "totalRows": 1,
        "totalCrashes": 500,
        "totalUploaded": 480,
        "rows": [
            {
                "appName": "All",
                "series": [
                    {
                        "day": 738387,
                        "timestamp": 1629417600,
                        "totalCrashCount": 20,
                        "throttleCrashCount": 2,
                        "retireCrashCount": 0,
                        "uploadedCount": 18
                    }
                ]
            }
        ]
    },
    "lastCrashTime": "2026-02-20T12:05:00Z",
    "recentCrashes": [
        {
            "id": 1,
            "status": 0,
            "stackKey": "crash_in_main",
            "stackKeyId": 42,
            "crashTime": "2026-02-20T12:00:00Z",
            "appName": "MyApp",
            "appVersion": "1.0",
            "exceptionMessage": "Access violation"
        }
    ],
    "statusCounts": {
        "current": {
            "open": 10,
            "closed": 5,
            "regression": 2,
            "ignored": 1,
            "total": 18
        },
        "previous": {
            "open": 8,
            "closed": 6,
            "regression": 1,
            "ignored": 2,
            "total": 17
        }
    },
    "topStackKeys": [
        {
            "stackKey": "crash_in_main",
            "stackKeyId": 42,
            "crashSum": 150
        }
    ],
    "totalThrottled": 3,
    "totalThrottledPrevious": 2
}
```

{% endtab %}
{% endtabs %}

### Response Fields

| Field                  | Type   | Description                                                                                                                                                                                                                                                                                                                                                      |
| ---------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| status                 | string | `"success"` on success                                                                                                                                                                                                                                                                                                                                           |
| database               | string | The database name                                                                                                                                                                                                                                                                                                                                                |
| volume30Day            | number | Total crash count in the last 30 days, counted when reports are accepted for upload. Includes reports that never finished uploading                                                                                                                                                                                                                              |
| uploaded30Day          | number | Number of crash reports that completed upload and were stored in the last 30 days. May be lower than `volume30Day` when clients abandon uploads                                                                                                                                                                                                                  |
| crashDataDays          | number | Number of days of crash data available                                                                                                                                                                                                                                                                                                                           |
| crashHistory           | object | Chart data for crash volume over time. Contains `totalRows`, `totalCrashes`, `totalUploaded`, and `rows` array. Each series entry contains `totalCrashCount`, `throttleCrashCount`, `retireCrashCount`, and `uploadedCount`. `totalCrashCount` already includes the throttled reports, so accepted-for-upload reports are `totalCrashCount - throttleCrashCount` |
| lastCrashTime          | string | ISO 8601 timestamp of the most recent crash overall, not limited by the requested time range or filters. `null` if no crashes exist                                                                                                                                                                                                                              |
| recentCrashes          | array  | The 5 most recent crashes in the time range                                                                                                                                                                                                                                                                                                                      |
| statusCounts           | object | Crash group status breakdown for `current` and `previous` time periods                                                                                                                                                                                                                                                                                           |
| topStackKeys           | array  | Top 6 stack keys by crash count in the time range                                                                                                                                                                                                                                                                                                                |
| totalThrottled         | number | Total number of throttled crashes in the time range                                                                                                                                                                                                                                                                                                              |
| totalThrottledPrevious | number | Total number of throttled crashes in the previous time period                                                                                                                                                                                                                                                                                                    |

### Curl Example

```bash
curl --location 'https://app.bugsplat.com/api/dashboard?database=fred&startDate=2025-01-01T00%3A00%3A00.000Z&endDate=2026-02-23T00%3A00%3A00.000Z' \
--header 'Authorization: Bearer ••••••'
```

### Curl Example (Default Date Range)

```bash
curl --location 'https://app.bugsplat.com/api/dashboard?database=fred' \
--header 'Authorization: Bearer ••••••'
```

Omitting `startDate` and `endDate` does not return all-time data; it defaults to the last 365 days.

### Curl Example (with filters)

```bash
curl --location 'https://app.bugsplat.com/api/dashboard?database=fred&startDate=2025-01-01T00%3A00%3A00.000Z&endDate=2026-02-23T00%3A00%3A00.000Z&appNames=MyConsoleCrasher&appVersions=1.0&interval=hourly' \
--header 'Authorization: Bearer ••••••'
```


---

# 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.bugsplat.com/api-reference/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.
