SAsahha
Insights

Get comparisons (Account Authorization)

Gets comparison data for a profile with account authorization. Can be filtered by name, category, and date range.

get/api/v1/profile/insight/comparison/{externalId}

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

Path parameters

externalIdstring required

Query parameters

startDateTimestring date-time
endDateTimestring date-time
namestring
categorystring
periodicitystring
versionnumber float

Response

Success

idstring uuid

Unique identifier for the comparison.

typestring

The type of the data structure, always 'comparison'.

categorystring

The category of the comparison, such as 'score', 'factor', or 'biomarker'.

namestring

The name of the metric being compared.

valuenumber double

The current value of the metric being compared.

unitstring

The unit of measurement for the values.

isHigherBetterboolean nullable

Indicates if higher values are better for this comparison.

startDateTimestring date-time

The start datetime for the comparison period.

endDateTimestring date-time

The end datetime for the comparison period.

periodicitystring

The time period the comparison represents, e.g., 'daily', 'weekly'.

createdAtUtcstring date-time

The UTC timestamp when this comparison was created.

versionnumber float

The version of the comparison algorithm used.

Example response

[
  {
    "id": "2F9EA4F8-8A96-4AC2-88B5-001EE6FC2CCD",
    "type": "comparison",
    "category": "score",
    "name": "readiness",
    "unit": "index",
    "startDateTime": "2025-04-02T00:00:00.0000000+00:00",
    "endDateTime": "2025-04-02T23:59:59.0000000+00:00",
    "periodicity": "daily",
    "data": [
      {
        "type": "demographic",
        "state": "medium"
      }
    ],
    "createdAtUtc": "2023-05-16T09:30:00.0000000+00:00"
  }
]

Changes

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