SAsahha
Scores

Get scores (Profile Authorization)

Gets scores for a given time window for a profile.

get/api/v1/profile/score

Request

  • Base URL
    https://api.sahha.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header Authorization

Query parameters

typesstring[]
startDateTimestring date-time
endDateTimestring date-time
versionnumber float

Response

Success

idstring uuid

Unique identifier for the inference.

typestring

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.

statestring

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.

scorenumber 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.

dataSourcesstring[]

Lists the features that were used to generate the inference. This can include features like age, gender, sleep, and activity.

scoreDateTimestring date-time

Date and Time the score is for.

createdAtUtcstring date-time

Date the inference was generated.

versionnumber float

Version number for the inference.

Example response

[
  {
    "id": "2F9EA4F8-8A96-4AC2-88B5-001EE6FC2CCD",
    "type": "activity",
    "state": "medium",
    "scoreDateTime": "2023-01-01T00:00:00.0000000+00:00",
    "createdAtUtc": "2023-01-01T00:00:00.0000000+00:00"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.