---
title: "POST get-file-stats"
method: POST
path: "get-file-stats"
---

# POST get-file-stats

`POST get-file-stats`

## Request

- Base URL: `https://design.penpot.app/api/main/methods`
- URL: `https://design.penpot.app/api/main/methods/get-file-stats`
- Auth: none declared

Return aggregate statistics for a single file: page count, shape
counts by type, component/color/typography counts, and inbound and
outbound library reference counts. Cheap alternative to `get-file`
when only metrics are needed.

## Request body

- object
  - `id` string, uuid, required: UUID formatted string

## Response `default`

A default response

- object
  - `fileId` string, uuid, required: UUID formatted string
  - `pageCount` integer, required: integer
  - `shapeCounts` object, required
    - `total` integer, required: integer
    - `byType` object, required
  - `componentCount` integer, required: integer
  - `deletedComponentCount` integer, required: integer
  - `colorCount` integer, required: integer
  - `typographyCount` integer, required: integer
  - `libraryCount` integer, required: integer
  - `referencedByCount` integer, required: integer
  - `revn` integer, required: integer
  - `updatedAt` string, iso, required

---

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