---
title: "Summarise the journal"
method: GET
path: "/api/v1/journal/summary"
tags: ["Journal"]
---

# Summarise the journal

`GET /api/v1/journal/summary`

## Request

- Base URL: `https://pcp.example.com`
- URL: `https://pcp.example.com/api/v1/journal/summary`
- Auth: HTTP bearer

## Query parameters

- `organization_id` string, uuid
- `days` integer

## Response `200`

OK

- JournalSummary: JournalSummary schema
  - `backups_error` integer
  - `backups_success` integer
  - `backups_total` integer
  - `checks_error` integer
  - `checks_success` integer
  - `checks_total` integer
  - `end` string, date-time
  - `input_bytes` integer
  - `logical_read_bytes` integer
  - `logical_written_bytes` integer
  - `output_bytes` integer
  - `restores_error` integer
  - `restores_success` integer
  - `restores_total` integer
  - `start` string, date-time
  - `store_read_bytes` integer
  - `store_written_bytes` integer
  - `syncs_error` integer
  - `syncs_success` integer
  - `syncs_total` integer

## Other responses

- `400`: Bad Request _(validation or deserialization error)_
- `401`: Missing, invalid or expired credentials
- `403`: The caller may not do this
- `500`: Internal Server Error _(panics)_
- `default`

---

[API](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1.md) - [All operations](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1/revisions/2ac049494a01?raw)