Update a metric - Standard Metrics

Partially update a Datum's value, currency, or comment.

curl --request PATCH \
  --url https://api.standardmetrics.io/v1/metrics/{datum_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<string>",
  "comments": [
    {
      "content": "<string>"
    }
  ]
}
'

import requests

url = "https://api.standardmetrics.io/v1/metrics/{datum_id}/"

payload = {
    "value": "<string>",
    "comments": [{ "content": "<string>" }]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({value: '<string>', comments: [{content: '<string>'}]})
};

fetch('https://api.standardmetrics.io/v1/metrics/{datum_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.standardmetrics.io/v1/metrics/{datum_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'value' => '<string>',
    'comments' => [
        [
                'content' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.standardmetrics.io/v1/metrics/{datum_id}/"

	payload := strings.NewReader("{\n  \"value\": \"<string>\",\n  \"comments\": [\n    {\n      \"content\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.standardmetrics.io/v1/metrics/{datum_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"value\": \"<string>\",\n  \"comments\": [\n    {\n      \"content\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.standardmetrics.io/v1/metrics/{datum_id}/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"value\": \"<string>\",\n  \"comments\": [\n    {\n      \"content\": \"<string>\"\n    }\n  ]\n}"

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

{
  "id": "<string>",
  "value": "<string>",
  "currency": "AED",
  "comments": [
    {
      "content": "<string>",
      "updated_by": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

PATCH

/

metrics

/

{datum_id}

/

Partially update a Datum's value, currency, or comment.

curl --request PATCH \
  --url https://api.standardmetrics.io/v1/metrics/{datum_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<string>",
  "comments": [
    {
      "content": "<string>"
    }
  ]
}
'

import requests

url = "https://api.standardmetrics.io/v1/metrics/{datum_id}/"

payload = {
    "value": "<string>",
    "comments": [{ "content": "<string>" }]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({value: '<string>', comments: [{content: '<string>'}]})
};

fetch('https://api.standardmetrics.io/v1/metrics/{datum_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.standardmetrics.io/v1/metrics/{datum_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'value' => '<string>',
    'comments' => [
        [
                'content' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.standardmetrics.io/v1/metrics/{datum_id}/"

	payload := strings.NewReader("{\n  \"value\": \"<string>\",\n  \"comments\": [\n    {\n      \"content\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.standardmetrics.io/v1/metrics/{datum_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"value\": \"<string>\",\n  \"comments\": [\n    {\n      \"content\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.standardmetrics.io/v1/metrics/{datum_id}/")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"value\": \"<string>\",\n  \"comments\": [\n    {\n      \"content\": \"<string>\"\n    }\n  ]\n}"

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

{
  "id": "<string>",
  "value": "<string>",
  "currency": "AED",
  "comments": [
    {
      "content": "<string>",
      "updated_by": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

Your valid bearer token. All Auth tokens persist for all requests. Make sure to replace Client Credential Basic tokens with Bearer tokens after retrieving your bearer token. Go to the API Reference/Setup, User Guides/Initial Setup, or API Reference/Get API Access Token page to get your token.

Path Parameters

datum_id

string

required

Body

application/json

value

string

Minimum string length: 1

currency

enum<string>

Available options:

AED,

AUD,

BDT,

BRL,

CAD,

CHF,

CNY,

COP,

CZK,

DKK,

EUR,

GBP,

GHS,

HKD,

IDR,

ILS,

INR,

JPY,

JOD,

KES,

KRW,

MXN,

NGN,

NOK,

NZD,

PEN,

PHP,

SAR,

SGD,

USD,

PKR,

THB,

TRY,

TWD,

TZS,

VND,

SEK,

ISK,

ZAR

comments

object[]

Show child attributes

Response

200 - application/json

id

string

required

value

string

required

Minimum string length: 1

currency

enum<string> | null

required

Available options:

AED,

AUD,

BDT,

BRL,

CAD,

CHF,

CNY,

COP,

CZK,

DKK,

EUR,

GBP,

GHS,

HKD,

IDR,

ILS,

INR,

JPY,

JOD,

KES,

KRW,

MXN,

NGN,

NOK,

NZD,

PEN,

PHP,

SAR,

SGD,

USD,

PKR,

THB,

TRY,

TWD,

TZS,

VND,

SEK,

ISK,

ZAR

comments

object[]

required

Show child attributes