---
title: "Health Score of a store API"
method: GET
path: "/public/api/stores/{id}/health-score?days{days}"
tags: ["Stores"]
---

# Health Score of a store API

`GET /public/api/stores/{id}/health-score?days{days}`

## Request

- Base URL: `https://<base_url>`
- URL: `https://<base_url>/public/api/stores/{id}/health-score?days{days}`
- Auth: HTTP bearer

An in house KPI to help measure a store's condition.
The Health Score is determined according to 4 criteria:

- `reactivity`: Percentage of completed missions on time.

- `accuracy`: Percentage of compliant missions.

- `compliance`: Percentage of compliant campaigns. Campaign compliancy is set when the last mission on the store is compliant.

- `review`: This concept aims to integrate audits completed by managers over the store in the Health Score

The final score is then given with two additional parameters:

- `healthscore`: Is the final grade calculated according to the average of the 4 criteria above.

- `evolution`: This is the history of the store's `healthscore` (determined by the `days` parameter and defaults to `7`).

## Query parameters

- `days` number

## Headers

- `Accept` string

## Response `200`

OK

- object
  - `healthscore` object
    - `today` number
    - `yesterday` number
  - `reactivity` object
    - `today` number
    - `yesterday` number
  - `compliance` object
    - `today` number
    - `yesterday` number
  - `accuracy` object
    - `today` number
    - `yesterday` number
  - `review` object
    - `today` number
    - `yesterday` number
  - `evolution` object
    - `lowest` number
    - `highest` number
    - `evolution` object[]
      - `date` string, required
      - `value` number, required
    - `current` number

## Changes

- **2026-09-04** `acd097fdd2f1`: 1 info
  - the endpoint scheme security `oauth2` was removed from the API

[Operation history](https://skmtc.dev/yoobic/apis/yoobic-public-api/changes/public/api/stores/:id/health-score%3Fdays:days/get.md)

---

[API](https://skmtc.dev/yoobic/apis/yoobic-public-api.md) - [All operations](https://skmtc.dev/yoobic/apis/yoobic-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yoobic/apis/yoobic-public-api/revisions/346dadb64873?raw)
