---
title: "Get scores (Account Authorization)"
method: GET
path: "/api/v1/profile/score/{externalId}"
tags: ["Scores"]
---

# Get scores (Account Authorization)

`GET /api/v1/profile/score/{externalId}`

## Request

- Base URL: `https://api.sahha.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.sahha.ai/api/v1/profile/score/{externalId}`
- Auth: API key in header `Authorization`

Gets scores for a given time window for a profile.

## Path parameters

- `externalId` string, required

## Query parameters

- `types` string[]
- `startDateTime` string, date-time
- `endDateTime` string, date-time
- `version` number, float

## Response `200`

Success

- ScoreDto[]
  - `id` string, uuid: Unique identifier for the inference.
  - `type` string: Specifies the type of score being reported, such as stress_resilience or depression_resilience. The type informs the client about which aspect of health the inference relates to.
  - `state` string: Indicates the category of the score in a descriptive manner. Categories include none, low, medium, or high. This field provides a qualitative summary of the corresponding score.
  - `score` number, float: The numerical value of the health score, ranging between 0 and 1. Higher scores typically indicate better mental and physical well-being based on the features analyzed.
  - `factors` ScoreFactorDto[]: A list of objects that break down the score contributions of different features such as sleep_routine, daily_activity, etc. Each object in the list specifies how much a particular feature has contributed to the final score.
    - `id` string, uuid
    - `name` string, nullable
    - `value` number, double, nullable
    - `goal` number, double, nullable
    - `score` number, double, nullable
    - `state` string, nullable
    - `unit` string, nullable
  - `dataSources` string[]: Lists the features that were used to generate the inference. This can include features like age, gender, sleep, and activity.
  - `scoreDateTime` string, date-time: Date and Time the score is for.
  - `createdAtUtc` string, date-time: Date the inference was generated.
  - `version` number, float: Version number for the inference.

## Other responses

- `400`: Returned if the provided profile id is invalid.
- `401`: Returned if the authorization token is invalid.

---

[API](https://skmtc.dev/sahha/apis/sahha-platform-v1.md) - [All operations](https://skmtc.dev/sahha/apis/sahha-platform-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/sahha/apis/sahha-platform-v1/revisions/c7f918b46707?raw)