---
title: "Get analytics"
description: "The home page counters: orders delivered and files downloaded, for all time or this calendar month (period=all_time|this_month)."
url: https://docs.filemonk.io/v2/api-reference/analytics/get-analytics/
api: "API v2 reference"
method: GET
path: "/analytics"
---

# Get analytics

`GET https://app.filemonk.io/api/v2/external/analytics`

The home page counters: orders delivered and files downloaded, for all time or this calendar month (period=all_time|this_month).

## Query parameters

- `period` (string) One of: `all_time`, `this_month`.

## Returns

- `period` (string, nullable, required): e.g. `all_time`
- `orders_count` (integer, nullable, required): e.g. `48`
- `downloads_count` (integer, nullable, required): e.g. `18`

Rate limit: this call costs 1 point ([rate limits](https://docs.filemonk.io/v2/errors-and-rate-limits/)).

## Examples

### Get analytics

```sh
curl "https://app.filemonk.io/api/v2/external/analytics" \
  -H "X-Auth-Token: $FILEMONK_API_KEY"
```

### Get analytics filtered by period

```sh
curl "https://app.filemonk.io/api/v2/external/analytics?period=all_time" \
  -H "X-Auth-Token: $FILEMONK_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "period": "all_time",
  "orders_count": 48,
  "downloads_count": 18
}
```

## 401

Missing or invalid API key.

```json
{
  "errors": [
    "Invalid API key"
  ]
}
```

## 422

The request failed validation, or sent a key the action does not take (`code: "unknown_parameters"` with `unknown` and `accepted`). Nothing was saved.

```json
{
  "errors": [
    "access.download_limit_count must be an integer of at least 0"
  ],
  "field_errors": {
    "access.download_limit_count": [
      "must be an integer of at least 0"
    ]
  }
}
```

## 429

Rate limited. Cost-weighted per API key, shared with API v1: a read costs 1 point, a write 2, 40 points per fixed 60-second window. Every response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` (Unix time the window ends); a 429 adds `Retry-After` (seconds), `retry_after`, `retryable: true` and a `next_step` in the body. A 429 did nothing: wait `retry_after` seconds, then send the same request again. The budget is per key, so every tool or script using the key shares it; prefer one list call with `per_page` over many single reads.

```json
{
  "errors": [
    "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
  ],
  "code": "rate_limited",
  "retry_after": 12,
  "error": "Rate limit exceeded",
  "message": "You have exceeded the rate limit of 40 points per 60 seconds. Read requests cost 1 point(s) and write requests cost 2 point(s). Please retry after 12 second(s)."
}
```