> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squasher.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Observability Summary API

> Get a compact operator-focused summary of the logs and latency metrics that matter right now.

Use this endpoint when you want a high-signal starting point before drilling into one metric or dashboard query.

## Get an operator summary

```text theme={null}
GET https://api.squasher.ai/v1/projects/{project_id}/observability-summary
```

Optional query parameters:

* `service_name` - scope the summary to one `service.name`
* `environment` - filter one deployment environment
* `metric_query` - narrow metric discovery with a search string such as `duration`
* `from`
* `to`
* `metric_limit` - default `3`, max `5`
* `log_limit` - default `8`, max `20`

Example:

```text theme={null}
GET https://api.squasher.ai/v1/projects/{project_id}/observability-summary?service_name=api&metric_query=duration
```

The response is intentionally compact and machine-friendly:

* `highlights` - short sentences about the main things to notice
* `logs.levels` - total counts by severity
* `logs.top_sources`
* `logs.top_releases`
* `logs.recent_notable`
* `metrics.candidate_metrics` - the strongest metric candidates the API found
* `metrics.selected_metrics` - the metrics it actually summarized with `avg`, `p50`, `p90`, and `p99`

## CLI and MCP parity

The same summary is available through:

* `squasher observe summary`
* MCP Code Mode with `search("observability-summary")` followed by `execute`

## Agent handoff

Use this endpoint as the first live-data read during an investigation:

```text theme={null}
Get a Squasher observability summary for project <project_id>. Scope by service_name, environment, metric_query, from, and to when available. Use the highlights to decide whether the next query should be logs, metrics, traces, errors, or dashboards.
```

## Related docs

* [Metrics API](/api-reference/metrics)
* [Dashboards API](/api-reference/dashboards)
* [Query Guide API](/api-reference/query-guide)