# @apollo/usage-reporting-protobuf

> Protobuf format for Apollo usage reporting

Latest version **4.1.2** (published 2026-05-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @apollo/usage-reporting-protobuf
pnpm add @apollo/usage-reporting-protobuf
yarn add @apollo/usage-reporting-protobuf
bun add @apollo/usage-reporting-protobuf
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; high maintenance score; popular repo.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 4.1.2 |
| Published | 2026-05-04 |
| First published | 2022-07-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 991.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 13951 |
| Author | Apollo |
| Maintainers | glasser, dkuc, phryneas, apollo-bot, abernix |
| Keywords | GraphQL, Apollo, Server, Javascript |

## Links

- npm: https://www.npmjs.com/package/@apollo/usage-reporting-protobuf
- Repository: https://github.com/apollographql/apollo-server
- Homepage: https://github.com/apollographql/apollo-server#readme
- Issues: https://github.com/apollographql/apollo-server/issues
- npm.io page: https://npm.io/package/@apollo/usage-reporting-protobuf

## Dependencies (1)

- [@apollo/protobufjs](https://npm.io/package/@apollo/protobufjs.md) 1.2.8

## Alternatives

- [apollo-link-http-common](https://npm.io/package/apollo-link-http-common.md) — 879.0K weekly downloads
- [react-relay](https://npm.io/package/react-relay.md) — 336.8K weekly downloads
- [relay-test-utils](https://npm.io/package/relay-test-utils.md) — 181.6K weekly downloads
- [@vendure/core](https://npm.io/package/@vendure/core.md) — 14.8K weekly downloads
- [@pnpm/deps.graph-sequencer](https://npm.io/package/@pnpm/deps.graph-sequencer.md) — 13.4K weekly downloads

## Recent versions

- 4.1.2 (latest) — 2026-05-04
- 4.0.0-rc.2 (rc) — 2022-09-30
- 4.0.0-alpha.0 (alpha) — 2022-07-13
- 4.1.1 — 2023-06-26
- 4.1.0 — 2023-03-02
- 4.0.2 — 2022-11-09
- 4.0.1 — 2022-10-28
- 4.0.0 — 2022-10-10
- 4.0.0-alpha.1 — 2022-07-22

## README

# `apollo-reporting-protobuf`

> **Note:** The Apollo usage reporting API is subject to change.  We strongly
> encourage developers to contact Apollo support at `support@apollographql.com`
> to discuss their use case prior to building their own reporting agent using
> this module.

This module provides JavaScript/TypeScript
[Protocol buffer](https://developers.google.com/protocol-buffers/) definitions
for the Apollo usage reporting API.  These definitions are generated for
consumption from the `reports.proto` file which is defined internally within
Apollo.

## Development

> **Note:** Due to a dependency on Unix tools (e.g. `bash`, `grep`, etc.), the
> development of this module requires a Unix system.  There is no reason why
> this can't be avoided, the time just hasn't been taken to make those changes.
> We'd happily accept a PR which makes the appropriate changes!

Currently, this package generates a majority of its code with
`@apollo/protobufjs` (a fork of
[`protobufjs`](https://www.npmjs.com/package/protobufjs) that we maintain
specifically for this package) based on the `reports.proto` file. The output is
generated with the `generate` npm script.

The root of the repository provides some `devDependencies` necessary to build
these definitions; these will be installed by running `npm install` at the root
of this workspace. When making changes to this module, run scripts via `npm run
SCRIPTNAME -w @apollo/usage-reporting-protobuf` in the **root** of this monorepo in
order to update the definitions in _this_ module. The `-w` flag is shorthand for
`--workspace`; this monorepo leverages NPM workspaces to manage its packages.

To update `reports.proto` to the current version recognized by the Studio usage
reporting ingress, run `npm run update-proto -w
@apollo/usage-reporting-protobuf`. To then regenerate the JS and TS files, run
`npm run generate -w @apollo/usage-reporting-protobuf`. We check in the
generated code and only regenerate it manually, partially to make builds faster
(no need to run pbjs on every `npm install`) and partially so that we don't have
to make sure that `pbjs` runs on every Node version that we support.

---
_Source: https://npm.io/package/@apollo/usage-reporting-protobuf · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._