Skip to main content

Overview

The Statistics API provides aggregated metrics about anonymous pull requests created through gitGost. All data is fully anonymized and contains no personally identifiable information.

GET /api/stats

Retrieve total PR count and most recent activity timestamp.

Request

Response

integer
required
Total number of anonymous PRs created through gitGost
string
ISO 8601 timestamp of the most recent PR creation. Only included if PRs exist.

Response Example

Empty State

If no PRs have been created yet:

GET /api/recent-prs

Retrieve the 10 most recent anonymous PRs.

Request

Response

array
required
Array of recent PR records
integer
Database record ID
string
Repository owner
string
Repository name
string
GitHub PR URL
string
ISO 8601 timestamp of PR creation
integer
required
Total number of PRs across all time

Response Example

GET /api/pr-status/:hash

Get notification subscription information for a specific PR hash.

Parameters

string
required
The PR hash returned after creating a PR (e.g., from git push output)

Request

Response

string
required
The provided PR hash
string
required
The ntfy topic name for this PR (derived from hash)
string
required
Full ntfy subscription URL for receiving PR notifications

Response Example

Notes

Privacy

  • All statistics are aggregated and anonymized
  • No user identities, IP addresses, or metadata are exposed
  • PR records contain only public GitHub URLs and timestamps

Caching

  • Stats endpoints have no caching (real-time data)
  • For badge caching behavior, see Badge Endpoints

Rate Limiting

Statistics endpoints are publicly accessible with no authentication or rate limiting.

Implementation Reference

Source: internal/http/handlers.go
  • StatsHandler (lines 926-957)
  • RecentPRsHandler (lines 959-984)
  • PRStatusHandler (lines 1655-1672)