Introduction

The Partnership API gives you full access to the data generated by Ultrahuman.

This documentation describes the API calls and properties of the returned objects.

If you have any questions, please don't hesitate to contact us.

Environments

Live Environment: '<https://partner.ultrahuman.com/api/v1/metrics>'

Pre Requisites

Each Partner will be given:

  1. Authorization key - to access apis.
  2. Data sharing code - Any user can enter this code on UH app. go to profile tab -> Settings -> Partner ID and then enter this code. This will give the Partner, access to read the user’s data through api.

API Request

These are the properties that you must include in every API call.

  1. Authorization ****An alpha-numeric string that gives you access to the API to be added in the Header as Authorization key.
  2. email Email of the user, data is fetched for. For e.g ([email protected])
  3. date ****Date for which data is required. ISO 8601 Date Format: YYYY-MM-DD (e.g., "2023-10-09")

<aside> <img src="https://beestat.io/img/notion/info.svg" alt="https://beestat.io/img/notion/info.svg" width="40px" /> Anyone with this Authorization Key can use the Ultrahuman API as you. If it is compromised, please send an email, and it can be deactivated or changed.

</aside>

With that in mind, the next step is to send a GET request to partner.ultrahuman.com with the appropriate values set.

curl --location --request GET '<https://partner.ultrahuman.com/api/v1/[email protected]&date=yyyy-mm-dd>' \\
--header 'Authorization: abssdsdsdsddsdss.eyJ1c2VyX2lkIjoxMTg5MDMwLCJleHAiOjE2NzE3NzMzNzl9.xU08oMCRIGyu3FcAP9wn-FajrfhsZ5luqXS_ESzkYVk'

API response

Response contains metrics for user for given date. Metrics contains