---
title: Document statistics (GET /api/v2/documents/{file_id}) | HelpRange API
description: GET /api/v2/documents/{file_id}: Views, downloads, total reading time, average seconds per page and the latest views (who, when, how long) of one document.
url: https://www.helprange.com/developers/api/get-document
---

GET

# Document statistics

`https://www.helprange.com/api/v2/documents/{file_id}`

Views, downloads, total reading time, average seconds per page and the latest views (who, when, how long) of one document.

**Plans:** Pro, Max, Unlimited, Deal Room Pass, trial. **Auth:** `Authorization: Bearer hr_live_…` (team key), `X-API-Key`, `Authorization: Api-Key <key>` or an OAuth `Bearer` token. **Scope:** `documents:read`. **Operation id:** `getDocument`

## Parameters

| Name | In | Type | Description |
|---|---|---|---|
| `file_id` required | path | integer | Document id (from List documents). (min 1) |
| `recent_views` | query | integer | How many latest views to return, 1–100 (default 20). (min 1, max 100) |

## Example request

```
curl -X GET 'https://www.helprange.com/api/v2/documents/250?recent_views=5' \
  -H "X-API-Key: $HELPRANGE_API_KEY"
```

```
const res = await fetch('https://www.helprange.com/api/v2/documents/250?recent_views=5', {
  method: 'GET',
  headers: {'X-API-Key': process.env.HELPRANGE_API_KEY},
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status}: ${data.error || data.message || data.reason}`);
console.log(data);
```

```
import os

import requests

r = requests.get(
    'https://www.helprange.com/api/v2/documents/250',
    headers={'X-API-Key': os.environ['HELPRANGE_API_KEY']},
    params={
        "recent_views": 5,
    },
    timeout=60,
)
r.raise_for_status()
print(r.json())
```

The samples read the key from the `HELPRANGE_API_KEY` environment variable.

## Responses

| Status | Description |
|---|---|
| `200` | OK |
| `401` | Missing or invalid API key / OAuth token. Team keys: code invalid_key, key_revoked, key_expired or key_owner_removed. |
| `402` | Your plan does not include the REST API (the Free plan) or this feature (e.g. NDA needs Max). |
| `403` | The team API key lacks the scope this endpoint needs. |
| `404` | Not found – or not yours (the API never says which). |
| `405` | Wrong HTTP method for this endpoint. |
| `429` | A usage limit was reached – wait Retry-After seconds. |

Example response · 200

```
{
  "id": 250,
  "name": "proposal.pdf",
  "type": "document",
  "pages": 12,
  "views": 39,
  "downloads": 2,
  "total_seconds_read": 1830,
  "last_viewed_at": "2026-11-09T14:02:11+00:00",
  "share_link": "https://www.helprange.com/view/471dcc98874d4d0cb7c3eb1874c4e3db/proposal.pdf",
  "avg_seconds_per_page": [
    {
      "page": 1,
      "avg_seconds": 21
    },
    {
      "page": 2,
      "avg_seconds": 64
    }
  ],
  "recent_views": [
    {
      "viewer": "anna@client.com",
      "opened_at": "2026-11-09T14:02:11+00:00",
      "seconds_read": 312,
      "country": "DE",
      "downloaded": false,
      "document": "proposal.pdf",
      "document_id": 250
    }
  ],
  "folder_id": 31,
  "folder": "Legal",
  "subfolder_id": null,
  "subfolder": null,
  "path": "Legal"
}
```

## Try it

**Uses your real account.** The request goes from your browser straight to `www.helprange.com` with your API key and acts as you. The key stays in this page (in this tab's session storage only if you tick the box), is never put in a URL and is not sent to analytics. Do not paste a key on a shared computer.
 API key

  Remember in this tab

file_id (path, required)

recent_views (query)

```

```
