readme/metrics

Track your API metrics within ReadMe.

11.1.0 2024-12-11 11:21 UTC

Requires

• php: ^8.1 | ^8.2 | ^8.3
• composer-runtime-api: ^2.2
• composer/composer: ^2.7
• guzzlehttp/guzzle: ^7.9
• illuminate/http: ^10.0 | ^11.0
• illuminate/support: ^10.0 | ^11.0
• phpoption/phpoption: ^1.9
• ramsey/uuid: ^4.7
• vlucas/phpdotenv: ^5.6

Requires (Dev)

• phpunit/phpunit: ^10.0 | ^11.0
• psalm/plugin-laravel: ^2.11.0
• squizlabs/php_codesniffer: ^3.10
• vimeo/psalm: 5.20.0

ISC

• readme
• api-metrics

README

Track usage of your API and troubleshoot issues faster.

With ReadMe's Metrics API your team can get deep insights into your API's usage. If you're a developer, it takes a few small steps to send your API logs to ReadMe. Here's an overview of how the integration works:

• You add the ReadMe middleware to your Laravel application.
• The middleware sends to ReadMe the response object that your Laravel application generates each time a user makes a request to your API. The entire response is sent, unless you allow or deny keys.
• ReadMe populates Metrics with this information, such as which endpoint is being called, response code, and error messages. It also identifies the customer who called your API, using whichever keys in the middleware you call out as containing relevant customer info.

composer require readme/metrics

For more information on setup, check out our integration documentation.

🚧 Any Issues?

Integrations can be tricky! Contact support if you have any questions/issues.