Create metrics

Create metrics.

POST /metrics

JavaScript

JavaScript

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

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

const response = await trophy.admin.metrics.create([
  {
    name: 'Invites Sent',
    key: 'invites-sent'
  },
  {
    name: 'Revenue',
    key: 'revenue',
    unitType: 'currency',
    units: 'USD'
  }
]);

from trophy import TrophyApi

client = TrophyApi(api_key='YOUR_API_KEY')

response = client.admin.metrics.create([
  {
    "name": "Invites Sent",
    "key": "invites-sent"
  },
  {
    "name": "Revenue",
    "key": "revenue",
    "unitType": "currency",
    "units": "USD"
  }
])

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.Create(context.TODO(), api.CreateMetricsRequest{})

curl --request POST \
  --url https://admin.trophy.so/v1/metrics \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
[
  {
    "name": "Invites Sent",
    "key": "invites-sent"
  },
  {
    "name": "Revenue",
    "key": "revenue",
    "unitType": "currency",
    "units": "USD"
  }
]
'

<?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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'name' => 'Invites Sent',
        'key' => 'invites-sent'
    ],
    [
        'name' => 'Revenue',
        'key' => 'revenue',
        'unitType' => 'currency',
        'units' => 'USD'
    ]
  ]),
  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.post("https://admin.trophy.so/v1/metrics")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"name\": \"Invites Sent\",\n    \"key\": \"invites-sent\"\n  },\n  {\n    \"name\": \"Revenue\",\n    \"key\": \"revenue\",\n    \"unitType\": \"currency\",\n    \"units\": \"USD\"\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::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"name\": \"Invites Sent\",\n    \"key\": \"invites-sent\"\n  },\n  {\n    \"name\": \"Revenue\",\n    \"key\": \"revenue\",\n    \"unitType\": \"currency\",\n    \"units\": \"USD\"\n  }\n]"

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

200

All requests had errors

{ "created": [], "issues": [ { "index": 0, "severity": "error", "message": "Name not a string" }, { "index": 1, "severity": "error", "message": "Key already in use by another metric" } ] }

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 create. Maximum 100 metrics per request.

Required array length: 1 - 100 elements

name · string · required

The metric name.

Example:

"Invites Sent"

key · string · required

The metric key. Only alphanumeric characters, hyphens, and underscores are permitted.

Pattern: ^[a-zA-Z\d-_]+$

Example:

"invites-sent"

unitType · enum<string> · default: number

The metric unit type. Defaults to number.

Available options: number, currency

Example:

"currency"

units · string

For unitType: currency, this must be a supported MetricCurrency code such as USD. For number, this is an optional freeform unit label.

Example:

"USD"

Response

200

application/json

Successful operation (no metrics created)

Response containing created metrics and any per-item issues.

created · CreatedMetric · object[] · required

Array of successfully created metrics.

Show child attributes

issues · AdminIssue · object[] · required

Array of issues encountered during metric creation.

Show child attributes