Document the metrics API contract and error codes

[mikewheeleer]

Document the metrics API

Description

The metrics endpoints lack a single reference for their request/response shapes and error codes, slowing integrators. This issue documents them.

Requirements and context

• Repository scope: Agentpay-Org/Agentpay-backend only.
• Add docs/metrics.md covering each metrics route, its params, response shape, and error codes.
• Cross-reference the handler; keep it accurate to the code.
• Include a request/response example per route.

Suggested execution

• Fork the repo and create a branch
• git checkout -b docs/metrics-01-api
• Implement changes
  • Write code in: the relevant module.
  • Write comprehensive tests in: cover the new behaviour and edge cases.
• Test and commit

Test and commit

• Run npm run lint, npm test, and npm run build.
• Cover edge cases: n/a — verify each documented route against source.
• Include the full test output in the PR description.

Example commit message

docs(metrics): document the API contract

Guidelines

• Minimum 95 percent test coverage for impacted modules.
• Clear, reviewer-focused documentation.
• Timeframe: 96 hours.

Community & contribution rewards

• 💬 Join the AgentPay community on Discord: https://discord.gg/eXvRKkgcv
• ⭐ This is a GrantFox OSS / Official Campaign task and may be rewarded. When your PR is merged you'll be prompted to rate the project — a 5-star rating is much appreciated.

[thlpkee20-wq]

Please consider assigning this issue to me, as I’m prepared to contribute wherever it’s needed, whether that involves protocol logic, interface creation, service-layer development, visual implementation, or cross-component coordination.

[grantfox-oss]

🦊 GrantFox — @thlpkee20-wq has been assigned to this issue as part of the Official Campaign | FWC26 campaign!

Next steps:

1. Open a Pull Request referencing this issue (e.g., Closes #390)
2. Your PR will be reviewed by the Agentpay-Org maintainers

Good luck! Track your progress on GrantFox.