Update metrics

Update metrics by ID.

PATCH /metrics

JavaScript

JavaScript

import { TrophyApiClient } from '@trophyso/node';

const trophy = new TrophyApiClient({
  apiKey: 'YOUR_API_KEY'
});

const response = await trophy.admin.metrics.update([
  {
    id: '550e8400-e29b-41d4-a716-446655440000',
    name: 'Invites Completed',
    units: 'invites'
  },
  {
    id: '550e8400-e29b-41d4-a716-446655440001',
    unitType: 'number',
    units: 'dollars'
  }
]);

from trophy import TrophyApi

client = TrophyApi(api_key='YOUR_API_KEY')

response = client.admin.metrics.update([
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Invites Completed",
    "units": "invites"
  },
  {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "unitType": "number",
    "units": "dollars"
  }
])

import (
  "context"

  api "github.com/trophyso/trophy-go"
  trophyclient "github.com/trophyso/trophy-go/client"
  "github.com/trophyso/trophy-go/option"
)

client := trophyclient.NewClient(
  option.WithApiKey("YOUR_API_KEY"),
)

response, err := client.Admin.Metrics.Update(context.TODO(), api.UpdateMetricsRequest{})

curl --request PATCH \
  --url https://admin.trophy.so/v1/metrics \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Invites Completed",
    "units": "invites"
  },
  {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "unitType": "number",
    "units": "dollars"
  }
]
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.trophy.so/v1/metrics",
  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([
    [
        'id' => '550e8400-e29b-41d4-a716-446655440000',
        'name' => 'Invites Completed',
        'units' => 'invites'
    ],
    [
        'id' => '550e8400-e29b-41d4-a716-446655440001',
        'unitType' => 'number',
        'units' => 'dollars'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

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

curl_close($curl);

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

HttpResponse<String> response = Unirest.patch("https://admin.trophy.so/v1/metrics")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"name\": \"Invites Completed\",\n    \"units\": \"invites\"\n  },\n  {\n    \"id\": \"550e8400-e29b-41d4-a716-446655440001\",\n    \"unitType\": \"number\",\n    \"units\": \"dollars\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://admin.trophy.so/v1/metrics")

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

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n    \"name\": \"Invites Completed\",\n    \"units\": \"invites\"\n  },\n  {\n    \"id\": \"550e8400-e29b-41d4-a716-446655440001\",\n    \"unitType\": \"number\",\n    \"units\": \"dollars\"\n  }\n]"

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

200

Success with no issues

{ "updated": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "name": "Invites Completed", "key": "invites-sent", "unitType": "number", "units": "invites" } ], "issues": [] }

Authorizations

X-API-KEY · string · header · required

Headers

Tenant-ID · string

The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. Pass your own internal customer ID for the tenant. Ignored for single-tenant organisations.

Body

application/json

Array of metrics to update. Each item must include an ID and may include any subset of mutable metric fields except key.

Required array length: 1 - 100 elements

id · string<uuid> · required

The UUID of the metric to update.

Example:

"550e8400-e29b-41d4-a716-446655440000"

name · string

The updated metric name.

Example:

"Invites Completed"

unitType · enum<string>

The updated metric unit type.

Available options: number, currency

Example:

"currency"

units · string

The updated units value. For unitType: currency, this must be a supported MetricCurrency code such as USD.

Example:

"USD"

Response

200

application/json

Successful operation

Response containing updated metrics and any per-item issues identified by metric ID.

updated · CreatedMetric · object[] · required

Array of successfully updated metrics.

Show child attributes

issues · AdminIssue · object[] · required

Array of issues encountered during metric update.

Show child attributes