Posting Covariates

Once you have your access_token, you may start adding user data to Cardiogram in order to generate Risk Scores

Add covariate data to user

POST https://cardiogr.am/heart/oauth/users/:userId/covariates

The covariates endpoint helps store user metadata such as date of birth, weight, height, sex, and whether they're on beta blockers.

Path Parameters

Name

Type

Description

userId

string

/oauth/users/1/covariates

Headers

Name

Type

Description

Authentication

string

Bearer <access_token>

Request Body

Name

Type

Description

Covariates

object

{ dateOfBirth: <String> (YYYY-MM-DD) height: <String> (180 | 5'9") heightUnit: <Enum> ("cm" | "ft/in") weight: <String> (140 | 65) weightUnit: <Enum> ("lb" | "kg") sex: <Enum> ("Male" | "Female") isOnBetaBlocker: <Boolean> }

{ "success": true }

// One of the following messages:
{ "message": "Malformed input." }
{ "message": "Step values contain negative value." }
{ "message": "Timestamps ('start' or 'end') are not in UNIX seconds" }
{ "message": "End time greater than start time for a step data point." }

Code Sample:

curl --location --request POST "https://cardiogr.am/heart/oauth/users/1/covariates" \
  --header "Content-Type: application/json" \
  --data "{
    \"dateOfBirth\": \"1980-01-01\",
    \"height\": \"175\",
    \"heightUnit\": \"cm\",
    \"weight\": \"70\",
    \"weightUnit\": \"kg\",
    \"isOnBetaBlocker\": false
  }"

var settings = {
  "url": "https://cardiogr.am/heart/oauth/users/1/covariates",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json"
  },
  "data": "{
    \"dateOfBirth\": \"1980-01-01\",
    \"height\": \"175\",
    \"heightUnit\": \"cm\",
    \"weight\": \"70\",
    \"weightUnit\": \"kg\",
    \"isOnBetaBlocker\": false
  }",
};
$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests
url = 'https://cardiogr.am/heart/oauth/users/1/covariates'
payload = "{
  \"dateOfBirth\": \"1980-01-01\",
  \"height\": \"175\",
  \"heightUnit\": \"cm\",
  \"weight\": \"70\",
  \"weightUnit\": \"kg\",
  \"isOnBetaBlocker\": false
}"
headers = {
  'Content-Type': 'application/json'
}
response = requests.request('POST', url, headers = headers, data = payload, allow_redirects=False, timeout=undefined, allow_redirects=false)
print(response.text)

require "uri"
require "net/http"

url = URI("https://cardiogr.am/heart/oauth/users/1/covariates")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request.body = "{
  \"dateOfBirth\": \"1980-01-01\",
  \"height\": \"175\",
  \"heightUnit\": \"cm\",
  \"weight\": \"70\",
  \"weightUnit\": \"kg\",
  \"isOnBetaBlocker\": false
}"

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://cardiogr.am/heart/oauth/users/1/covariates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => false,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{
    \"dateOfBirth\": \"1980-01-01\",
    \"height\": \"175\",
    \"heightUnit\": \"cm\",
    \"weight\": \"70\",
    \"weightUnit\": \"kg\",
    \"isOnBetaBlocker\": false
  }",
  CURLOPT_HTTPHEADER => array(
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
} ?>

package main

import (
  "fmt"
  "strings"
  "os"
  "path/filepath"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://cardiogr.am/heart/oauth/users/1/covariates"
  method := "POST"

  payload := strings.NewReader("{
    \"dateOfBirth\": \"1980-01-01\",
    \"height\": \"175\",
    \"heightUnit\": \"cm\",
    \"weight\": \"70\",
    \"weightUnit\": \"kg\",
    \"isOnBetaBlocker\": false
  }")

  client := &http.Client {
    CheckRedirect: func(req *http.Request, via []*http.Request) error {
      return http.ErrUseLastResponse
    },
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}

PreviousPosting Steps NextGetting User Info

Last updated 7 years ago

Was this helpful?

hashtagAdd covariate data to user

hashtagPath Parameters

hashtagHeaders

hashtagRequest Body

hashtagCode Sample:

Add covariate data to user

Path Parameters

Headers

Request Body

Code Sample: