Skip to Content
UsageMapDocs

Share your numbers

Public stats page, README badge, signed snapshots for grant reports, and a JSON metrics document.

Your numbers are private until you choose to share them. All sharing is set up under the project's Sharing and Traction snapshots tabs.

Public stats page

Turn on public stats and your project gets a page at app.usagemap.dev/p/your-short-name that anyone can open without signing in. It shows web and API usage, the traffic that was not counted, and your signed snapshots.

Badge

The public page offers Embed a badge: a live badge for your README or website.

Signed snapshots

Freeze a period into a signed document, with presets for an SCF build tranche, a campaign, a quarter or a custom range. Anyone can check one at app.usagemap.dev/verify.

Metrics document (JSON)

GET https://app.usagemap.dev/public/v1/projects/your-short-name/metrics.json, rebuilt hourly. Public when public stats are on; otherwise send a share key.

Share keys

To share your metrics document without making it public, create a share key (scfa_pub_…) under Sharing and send it in a header:

curl -H "Authorization: Bearer $USAGEMAP_SHARE_KEY" \
  https://app.usagemap.dev/public/v1/projects/your-short-name/metrics.json

A share key only reads that one document. It can't see dashboards, change settings or send data. Keys in a URL are refused, so they don't end up in logs.

Anonymous reports

Under a website's Settings, Anonymous reports hides rows with fewer than 10 visitors and rounds the rest to the nearest 10, so that small numbers can't single anyone out.

On this page