# List pulse

URL: https://docs.hanzo.ai/docs/openapi/leaderboard/get-leaderboard-pulse

> Returns how fast the platform is being used and is spreading, as counts by day for thirty days and by hour for the last day: tokens used, orgs active, orgs signed up, orgs that came through a referral link, orgs using a model for the first time (with the models most tried), and how many different models were in use (variety).

`GET /v1/leaderboard/pulse`

> [Leaderboard →](https://docs.hanzo.ai/docs/openapi/leaderboard) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                             |
| ------------- | ------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/leaderboard/pulse` |
| **Method**    | `GET`                                       |
| **Operation** | `get_leaderboard_pulse`                     |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`      |

Returns how fast the platform is being used and is spreading, as counts by day for
thirty days and by hour for the last day: tokens used, orgs active, orgs signed up,
orgs that came through a referral link, orgs using a model for the first time (with
the models most tried), and how many different models were in use (variety). Every
series is read from where cloud records it; one that cannot be read is left out and
named in `missing`, and the ones nothing records today (orgs trying a product,
shares) are always named there. Counts only: no org, no name. No credential is
needed to read it.

## Request

`GET /v1/leaderboard/pulse` takes no parameters and no body — the credential is the whole request.

## Response

| Status    | Body                  | Meaning |
| --------- | --------------------- | ------- |
| `200`     | leaderboard.PulseView | ok      |
| `default` | problem-details       | refused |

`200` body — 25 fields.

| Field            | In   | Type                      | Always | Description                                                                                                                             |
| ---------------- | ---- | ------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| `available`      | body | boolean                   | —      | Available is false when no series could be read at all.                                                                                 |
| `days`           | body | string\[]                 | —      | Days are the thirty days counted, oldest first, "2006-01-02" in UTC, ending today.                                                      |
| `hours`          | body | string\[]                 | —      | Hours are the twenty-four hours counted, oldest first, RFC 3339 in UTC, ending in the current hour.                                     |
| `missing`        | body | string\[]                 | —      | Missing names every series not drawn: the ones nothing records (products, shares) and the ones whose source could not be read just now. |
| `models`         | body | leaderboard.PulseSeries   | —      |                                                                                                                                         |
| `models.days`    | body | integer (int64)\[]        | —      | Days is one count a day, aligned with PulseView\.Days.                                                                                  |
| `models.hours`   | body | integer (int64)\[]        | —      | Hours is one count an hour, aligned with PulseView\.Hours.                                                                              |
| `orgs`           | body | leaderboard.PulseSeries   | —      |                                                                                                                                         |
| `orgs.days`      | body | integer (int64)\[]        | —      | Days is one count a day, aligned with PulseView\.Days.                                                                                  |
| `orgs.hours`     | body | integer (int64)\[]        | —      | Hours is one count an hour, aligned with PulseView\.Hours.                                                                              |
| `referred`       | body | leaderboard.PulseSeries   | —      |                                                                                                                                         |
| `referred.days`  | body | integer (int64)\[]        | —      | Days is one count a day, aligned with PulseView\.Days.                                                                                  |
| `referred.hours` | body | integer (int64)\[]        | —      | Hours is one count an hour, aligned with PulseView\.Hours.                                                                              |
| `signups`        | body | leaderboard.PulseSeries   | —      |                                                                                                                                         |
| `signups.days`   | body | integer (int64)\[]        | —      | Days is one count a day, aligned with PulseView\.Days.                                                                                  |
| `signups.hours`  | body | integer (int64)\[]        | —      | Hours is one count an hour, aligned with PulseView\.Hours.                                                                              |
| `tokens`         | body | leaderboard.PulseSeries   | —      |                                                                                                                                         |
| `tokens.days`    | body | integer (int64)\[]        | —      | Days is one count a day, aligned with PulseView\.Days.                                                                                  |
| `tokens.hours`   | body | integer (int64)\[]        | —      | Hours is one count an hour, aligned with PulseView\.Hours.                                                                              |
| `tries`          | body | leaderboard.PulseTally\[] | —      | Tries is the models orgs used for the first time in the window, most first.                                                             |
| `tries[].count`  | body | integer (int64)           | —      | Count is how many orgs used it for the first time in the window.                                                                        |
| `tries[].name`   | body | string                    | —      | Name is the model.                                                                                                                      |
| `variety`        | body | leaderboard.PulseSeries   | —      |                                                                                                                                         |
| `variety.days`   | body | integer (int64)\[]        | —      | Days is one count a day, aligned with PulseView\.Days.                                                                                  |
| `variety.hours`  | body | integer (int64)\[]        | —      | Hours is one count an hour, aligned with PulseView\.Hours.                                                                              |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo leaderboard pulse
```

**SDK**

**.ts**

```ts
import { Configuration, LeaderboardApi } from 'hanzoai';

const api = new LeaderboardApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getLeaderboardPulse();
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import LeaderboardApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = LeaderboardApi(client).get_leaderboard_pulse()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.LeaderboardAPI.GetLeaderboardPulse(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, leaderboard_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = leaderboard_api::get_leaderboard_pulse(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.LeaderboardApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new LeaderboardApi(client).getLeaderboardPulse();
```

The method above is the one at the current release of the document. `hanzoai@8.5.914` (npm) and `hanzoai@8.5.914` (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. [SDKs →](https://docs.hanzo.ai/docs/sdks)

**HTTP**

```bash
curl https://api.hanzo.ai/v1/leaderboard/pulse \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `leaderboard`, op `get_leaderboard_pulse` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "leaderboard",
         "arguments": {
           "op": "get_leaderboard_pulse",
           "input": {}
         }
       }
     }'
```

---

[Leaderboard API](https://docs.hanzo.ai/docs/openapi/leaderboard) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
