JavaScript
import { TrophyApiClient } from '@trophyso/node';
const trophy = new TrophyApiClient({
apiKey: 'YOUR_API_KEY'
});
const response = await trophy.points.levelSummary("points-system-key");from trophy import TrophyApi
client = TrophyApi(api_key='YOUR_API_KEY')
response = client.points.level_summary(key="points-system-key")
import (
"context"
trophyclient "github.com/trophyso/trophy-go/client"
"github.com/trophyso/trophy-go/option"
)
client := trophyclient.NewClient(
option.WithApiKey("YOUR_API_KEY"),
)
response, err := client.Points.LevelSummary(context.TODO(), "points-system-key")
curl --request GET \
--url https://api.trophy.so/v1/points/{key}/level-summary \
--header 'X-API-KEY: <api-key>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.trophy.so/v1/points/{key}/level-summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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.get("https://api.trophy.so/v1/points/{key}/level-summary")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trophy.so/v1/points/{key}/level-summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"level": {
"id": "1140fe51-6bce-4b44-b0ad-bddc4e123534",
"key": "bronze",
"name": "Bronze",
"description": "Starting level",
"badgeUrl": "https://example.com/bronze.png",
"points": 0
},
"users": 5012
},
{
"level": {
"id": "2240fe51-6bce-4b44-b0ad-bddc4e123534",
"key": "silver",
"name": "Silver",
"description": "Mid-tier level",
"badgeUrl": null,
"points": 50
},
"users": 1501
},
{
"level": {
"id": "3340fe51-6bce-4b44-b0ad-bddc4e123534",
"key": "gold",
"name": "Gold",
"description": "Top level",
"badgeUrl": "https://example.com/gold.png",
"points": 200
},
"users": 102
}
]{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Points
Get level summary for a points system
Get a breakdown of the number of users at each level in a points system.
GET
/
points
/
{key}
/
level-summary
JavaScript
import { TrophyApiClient } from '@trophyso/node';
const trophy = new TrophyApiClient({
apiKey: 'YOUR_API_KEY'
});
const response = await trophy.points.levelSummary("points-system-key");from trophy import TrophyApi
client = TrophyApi(api_key='YOUR_API_KEY')
response = client.points.level_summary(key="points-system-key")
import (
"context"
trophyclient "github.com/trophyso/trophy-go/client"
"github.com/trophyso/trophy-go/option"
)
client := trophyclient.NewClient(
option.WithApiKey("YOUR_API_KEY"),
)
response, err := client.Points.LevelSummary(context.TODO(), "points-system-key")
curl --request GET \
--url https://api.trophy.so/v1/points/{key}/level-summary \
--header 'X-API-KEY: <api-key>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.trophy.so/v1/points/{key}/level-summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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.get("https://api.trophy.so/v1/points/{key}/level-summary")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trophy.so/v1/points/{key}/level-summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"level": {
"id": "1140fe51-6bce-4b44-b0ad-bddc4e123534",
"key": "bronze",
"name": "Bronze",
"description": "Starting level",
"badgeUrl": "https://example.com/bronze.png",
"points": 0
},
"users": 5012
},
{
"level": {
"id": "2240fe51-6bce-4b44-b0ad-bddc4e123534",
"key": "silver",
"name": "Silver",
"description": "Mid-tier level",
"badgeUrl": null,
"points": 50
},
"users": 1501
},
{
"level": {
"id": "3340fe51-6bce-4b44-b0ad-bddc4e123534",
"key": "gold",
"name": "Gold",
"description": "Top level",
"badgeUrl": "https://example.com/gold.png",
"points": 200
},
"users": 102
}
]{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Headers
The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. The value should be your internal ID for the tenant. Ignored for single-tenant organisations.
Path Parameters
Key of the points system.
Was this page helpful?
⌘I