---
title: "See how a document performs"
method: GET
path: "/documents/{document_id}/performance"
tags: ["document"]
---

# See how a document performs

`GET /documents/{document_id}/performance`

## Request

- Base URL: `https://localhost:4410/api/v1`
- URL: `https://localhost:4410/api/v1/documents/{document_id}/performance`
- Auth: HTTP bearer

Across every visit that allowed page time, per version, newest first: the average share of the document read, the average seconds on each page, the share of visits that reached each page, and the pages read longest. Visits whose readers chose only what's needed are counted as visits and left out of the rest.

## Path parameters

- `document_id` string, required

## Response `200`

The result.

- object
  - `document_id` string, required
  - `versions` object[], required
    - `version` integer, required
    - `pages` integer, required
    - `visits` integer, required
    - `counted` integer, required
    - `average_read` number, nullable, required
    - `by_page` object[], required
      - `page` integer, required
      - `average_seconds` number, required
      - `reached` number, required
    - `top_pages` integer[], required

## Other responses

- `default`: An RFC 9457 problem.

---

[API](https://skmtc.dev/binderwork/apis/binderwork-api.md) · [All operations](https://skmtc.dev/binderwork/apis/binderwork-api/llms.txt) · [OpenAPI document](https://skmtc.dev/binderwork/apis/binderwork-api/revisions/f8fab0ebee53?raw)