PHPackages                             robertogallea/pulse-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. robertogallea/pulse-api

ActiveLibrary[API Development](/categories/api)

robertogallea/pulse-api
=======================

Add an API layer to Laravel Pulse metrics

1.0.3(1y ago)397.1k↓32.7%5PHPCI passing

Since Nov 11Pushed 1y ago1 watchersCompare

[ Source](https://github.com/robertogallea/pulse-api)[ Packagist](https://packagist.org/packages/robertogallea/pulse-api)[ RSS](/packages/robertogallea-pulse-api/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (5)Versions (5)Used By (0)

Access Laravel Pulse data using API
===================================

[](#access-laravel-pulse-data-using-api)

This package provides the very same information from [Laravel Pulse](https://pulse.laravel.com) as a JSON api endpoint.

[![17320370610423445938023068352330](https://private-user-images.githubusercontent.com/19411470/387768719-0ea30d54-97cc-40b6-8059-5afbe3b7bfb4.jpg?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzUzNDQwNjMsIm5iZiI6MTc3NTM0Mzc2MywicGF0aCI6Ii8xOTQxMTQ3MC8zODc3Njg3MTktMGVhMzBkNTQtOTdjYy00MGI2LTgwNTktNWFmYmUzYjdiZmI0LmpwZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA0MDQlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwNDA0VDIzMDI0M1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTY0MmNjNGYyM2U2MTA0Mjc0MjBiMTU1MDBlOGVmMmEwZDdhMDQyMDVhZGViMDdjMDFmMzQ2ZmFiMTViOTNkMmEmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.Da4tfH77Kc_o69rGxTzEuJHd7iuGizy7dMmurYGe9IA)](https://private-user-images.githubusercontent.com/19411470/387768719-0ea30d54-97cc-40b6-8059-5afbe3b7bfb4.jpg?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzUzNDQwNjMsIm5iZiI6MTc3NTM0Mzc2MywicGF0aCI6Ii8xOTQxMTQ3MC8zODc3Njg3MTktMGVhMzBkNTQtOTdjYy00MGI2LTgwNTktNWFmYmUzYjdiZmI0LmpwZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA0MDQlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwNDA0VDIzMDI0M1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTY0MmNjNGYyM2U2MTA0Mjc0MjBiMTU1MDBlOGVmMmEwZDdhMDQyMDVhZGViMDdjMDFmMzQ2ZmFiMTViOTNkMmEmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.Da4tfH77Kc_o69rGxTzEuJHd7iuGizy7dMmurYGe9IA)

Installation
------------

[](#installation)

You can install the package via composer:

```
composer require robertogallea/pulse-api
```

Usage
-----

[](#usage)

The package adds api endpoints to your application that exposes metrics collected by Pulse.

- `/api/pulse` - Provides the full set of metrics collected by Pulse
- `/api/pulse/{$type}` - Provides the metrics from a single type

By default, the available types are the one provided by Pulse itself:

- `servers`
- `usage`
- `queues`
- `cache`
- `slow_queries`
- `exceptions`
- `slow_requests`
- `slow_jobs`
- `slow_outgoing_requests`

However, you can integrate your own by mimicking any Pulse card or by using your own implementation.

Configuration
-------------

[](#configuration)

The file `config/pulse-api.php` defines the configuration and can be customized after publishing the package Service Provider.

```
php artisan vendor:publish --tag=pulse-api-config
```

### Access to endpoints

[](#access-to-endpoints)

The endpoint is allowed according to the logic defined by the middlewares defined in the `middleware` section of the config. By default, the following apply:

```
'middleware' => [
    'api',
    Authorize::class, // the default Pulse middleware
],
```

### Custom resources

[](#custom-resources)

Like in the web version of Pulse you can add your *Cards*, in PulseAPI you can add your own *Resources*, you can integrate the default ones by editing the `resources` configuration section:

```
'resources' =>
    \Robertogallea\PulseApi\Services\PulseAPI::getDefaultResources()->merge([
        // Add your custom resources
    ])->toArray(),
```

### Including recorders configuration in json response

[](#including-recorders-configuration-in-json-response)

Laravel Pulse cards use configuration to adjust the rendering of the card view. This may be not required or not useful in api but is enabled by default. You can disable the configuration exposure by proper setting of the `include-config` configuration key to `false`:

```
'include_config' => env('PULSE_API_INCLUDE_CONFIG', true),
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Credits
-------

[](#credits)

- [Roberto Gallea](https://github.com/robertogallea)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance43

Moderate activity, may be stable

Popularity37

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity42

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 68.4% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~15 days

Total

4

Last Release

507d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/818f547bcf73a82393d9014c85c90c83d760102a8d4dfe806353afb83848a901?d=identicon)[robertogallea](/maintainers/robertogallea)

---

Top Contributors

[![robertogallea](https://avatars.githubusercontent.com/u/19411470?v=4)](https://github.com/robertogallea "robertogallea (13 commits)")[![aminnausin](https://avatars.githubusercontent.com/u/83550431?v=4)](https://github.com/aminnausin "aminnausin (5 commits)")[![AdrianBav](https://avatars.githubusercontent.com/u/12467677?v=4)](https://github.com/AdrianBav "AdrianBav (1 commits)")

###  Code Quality

TestsPest

Static AnalysisPHPStan

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/robertogallea-pulse-api/health.svg)

```
[![Health](https://phpackages.com/badges/robertogallea-pulse-api/health.svg)](https://phpackages.com/packages/robertogallea-pulse-api)
```

###  Alternatives

[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[facebook/php-business-sdk

PHP SDK for Facebook Business

90821.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

74513.7M114](/packages/meilisearch-meilisearch-php)[google/common-protos

Google API Common Protos for PHP

173103.7M50](/packages/google-common-protos)[hubspot/api-client

Hubspot API client

23914.2M16](/packages/hubspot-api-client)[lstrojny/fxmlrpc

Fast and tiny XML/RPC client with bridges for various HTTP clients

1425.4M30](/packages/lstrojny-fxmlrpc)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)