Article Image

Access Laravel Pulse Data as a JSON API

Published on: Nov 18 2024
By: Paul Redmond

Pulse delivers at-a-glance insights into your application's performance and usage. Track down bottlenecks like slow jobs and endpoints, find your most active users, and more.

The Pulse API package by Roberto Gallea gives you all the data available in Laravel Pulse as a JSON API. This package defines two API endpoints for getting Pulse data. These API endpoints are protected using a configurable Pulse middleware for authorization:

  • /api/pulse
  • /api/pulse/{$type}

The /api/pulse/{$type} endpoint works with the following metric types provided by Pulse:

  • servers
  • usage
  • queues
  • cache
  • slow_queries
  • exceptions
  • slow_requests
  • slow_jobs
  • slow_outgoing_requests

You can learn more about this package, get full installation instructions, and view the source code on GitHub.