# Sales pulse card

> Canonical HTML: https://screenrig.ai/docs/cards/sales-pulse/

Today's revenue and orders with the day by hour, the latest orders and the top cities.

Category: Operations. Tags: Numbers and metrics, Charts and gauges, Stores.

## Previews

![Sales pulse](/cards/sales-pulse/v1/screenshots/canvas-bloom.webp?sha=7a82a019fe0a4aa18026791a730d893f9af2a7eab0fe2273ad5dd0d10ecae420)

Canvas

![Sales pulse](/cards/sales-pulse/v1/screenshots/corner-bloom.webp?sha=e6208456f7f11fd67430154121e8765e33fca19a6db53650f233ad808453f385)

Corner

![Sales pulse](/cards/sales-pulse/v1/screenshots/chip-bloom.webp?sha=0aaf99a67b44b7e090ab4bd586ce416bf79cabc71e855adbef9c7fc6b016021e)

Chip

## Views and forms

Views: canvas, corner, chip. Canvas forms: landscape, portrait, square, strip.

[Card views, themes and publishing](/docs/cards/). [Browse the gallery](/apps/#cards).

## Data and privacy

Feed: `screenrig.sales/v1`.

Feed documents carry source attribution. The Player supplies the feed to the card.

Shows revenue, order counts and the city of each order only; never a customer name, address or payment detail.

## Properties

For theme, background, accent and position, see [Common properties](/docs/cards/#common-properties).

Set static properties in `params`. Bind `data` to a project card data key for live values; that document holds only dynamic properties. Without a data key, put the complete configuration in `params`. Nested rows describe the contents of their parent property.

### Static properties

| Name | Type | Default | Values and limits | Description |
| --- | --- | --- | --- | --- |
| `title` | string | `"Sales pulse"` | maxLength: `40` |  |
| `currency` | string | `"USD"` | maxLength: `3` | ISO 4217 code; the feed's wins. |
| `rows` | integer | `5` | minimum: `1`; maximum: `8` | Rows in each list. |
| `staleMinutes` | integer | `15` | minimum: `1`; maximum: `1440` | A feed older than this shows how long ago it updated. |

### Dynamic properties

| Name | Type | Default | Values and limits | Description |
| --- | --- | --- | --- | --- |
| `store` | string | `""` | maxLength: `60` | The shop the numbers describe; the feed's wins. |
| `revenue` | number, null | `null` | minimum: `0`; maximum: `1000000000000` | Revenue so far today. |
| `orders` | integer, null | `null` | minimum: `0`; maximum: `100000000` | Orders so far today. |
| `goal` | number, null | `null` | minimum: `0`; maximum: `1000000000000` | Revenue goal for today; empty shows no goal. |
| `yesterdayRevenue` | number, null | `null` | minimum: `0`; maximum: `1000000000000` | Revenue by this time yesterday; empty shows no comparison. |
| `hourly` | array | `[]` | maxItems: `24` | Revenue for each hour of today in the screen's zone, midnight first. |
| `cities` | array | `[]` | maxItems: `20` | Revenue by city, the same document as the screenrig.sales/v1 feed's `cities`. |
| `cities[].name` | string |  | minLength: `1`; maxLength: `60`; Required | A city or region. |
| `cities[].revenue` | number |  | minimum: `0`; maximum: `1000000000`; Required | Revenue today from the city. |
| `recent` | array | `[]` | maxItems: `20` | The latest orders, the same document as the feed's `recent`. |
| `recent[].at` | string |  | minLength: `1`; maxLength: `40`; Required | When the order was placed, an ISO 8601 instant. |
| `recent[].amount` | number |  | minimum: `0`; maximum: `1000000000`; Required | The order total. |
| `recent[].city` | string | `""` | maxLength: `60` | Where it shipped to or was placed; never a customer. |

## Canvas example

Add this item to a playlist page’s `primitives`. [Publish the playlist and assign a screen](/docs/cards/#publish-a-card-canvas).

```json
{
  "id": "sales-pulse",
  "primitive": "card",
  "card": "sales-pulse",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "sales-pulse-main"
}
```

## Write live data

Create this document before showing the card, then replace it to update the screen without republishing. Use the same project as the playlist. Supply your API authorization through the environment; see [API authentication](/docs/authentication/).

```console
curl --request PUT "https://api.screenrig.ai/api/card-data/sales-pulse-main" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "ScreenRig-Project: $SCREENRIG_PROJECT" \
  --header "Content-Type: application/json" \
  --data '{"document":{"store":"","revenue":null,"orders":null,"goal":null,"yesterdayRevenue":null,"hourly":[],"cities":[],"recent":[]}}'
```