Welcome to Trophy

npm install @trophyso/node

gem install trophy_api_client

pip install trophy

composer require trophyso/php

implementation 'so.trophy:trophy-java:1.0.0'

<dependency>
  <groupId>so.trophy</groupId>
  <artifactId>trophy-java</artifactId>
  <version>1.0.0</version>
</dependency>

go get github.com/trophy-so/trophy-go

// .NET Core CLI
dotnet add package Trophy

// Nuget Package Manager
nuget install Trophy

// Visual Studio
Install-Package Trophy

curl -X POST https://api.trophy.so/v1/metrics/flashcards-flipped/event \
     -H "X-API-KEY: $TROPHY_API_KEY" \
     -H "Idempotency-Key: flashcard-view-42" \
     -H "Content-Type: application/json" \
     -d '{
  "user": {
    "id": "18",
    "email": "user@example.com",
    "tz": "Europe/London"
  },
  "value": 1
}'

import { TrophyApiClient } from "@trophyso/node";
import type { EventResponse } from "@trophyso/node/api";

const trophy = new TrophyApiClient({
  apiKey: process.env.TROPHY_API_KEY as string,
});

// user.id is required. email and tz are optional but recommended
// (tz is required for correct streak calendar days).
const response: EventResponse = await trophy.metrics.event(
  "flashcards-flipped",
  {
    user: {
      id: "18",
      email: "user@example.com",
      tz: "Europe/London",
    },
    value: 1,
    // Protects against duplicate events from the same flashcard
    idempotencyKey: "flashcard-view-42",
  }
);

from trophy import Trophy
from trophy.types import EventRequestUser

client = Trophy(
    api_key=os.environ.get("TROPHY_API_KEY"),
)

# user.id is required. email and tz are optional but recommended
# (tz is required for correct streak calendar days).
response = client.metrics.event(
    key="flashcards-flipped",
    user=EventRequestUser(
        id="18",
        email="user@example.com",
        tz="Europe/London",
    ),
    value=1.0,
    idempotencyKey="flashcard-view-42", # Protects against duplicate events from the same flashcard
)

use Trophy\TrophyClient;
use Trophy\Types\EventRequestUser;
use Trophy\Types\MetricsEventRequest;

$trophy = new TrophyClient([
    'apiKey' => getenv('TROPHY_API_KEY')
]);

// user.id is required. email and tz are optional but recommended
// (tz is required for correct streak calendar days).
$user = new EventRequestUser([
    'id' => '18',
    'email' => 'user@example.com',
    'tz' => 'Europe/London',
]);

$request = new MetricsEventRequest([
    'user' => $user,
    'value' => 1,
    // Protects against duplicate events from the same flashcard
    'idempotencyKey' => 'flashcard-view-42',
]);

$response = $trophy->metrics->event("flashcards-flipped", $request);

TrophyApiClient client = TrophyApiClient.builder()
    .apiKey(System.getenv("TROPHY_API_KEY"))
    .build();

// user.id is required. email and tz are optional but recommended
// (tz is required for correct streak calendar days).
MetricsEventRequest request = MetricsEventRequest.builder()
      .user(
        EventRequestUser.builder()
          .id("18")
          .email("user@example.com")
          .tz("Europe/London")
          .build()
      )
      .value(1)
      // Protects against duplicate events from the same flashcard
      .idempotencyKey("flashcard-view-42")
      .build();

EventResponse response = client.metrics().event("flashcards-flipped", request);

client, err := trophy.NewClient(
    option.WithAPIKey(os.Getenv("TROPHY_API_KEY")),
)
if err != nil {
    log.Fatal(err)
}

// user.id is required. email and tz are optional but recommended
// (tz is required for correct streak calendar days).
response, err := client.Metrics.Event(
    "flashcards-flipped",
    &api.MetricsEventRequest{
        User: &api.EventRequestUser{
            Id: "18",
            Email: "user@example.com",
            Tz: "Europe/London",
        },
        Value: 1,
        // Protects against duplicate events from the same flashcard
        IdempotencyKey: "flashcard-view-42",
    },
)

var trophy = new TrophyClient(
    Environment.GetEnvironmentVariable("TROPHY_API_KEY")
);

// user.id is required. email and tz are optional but recommended
// (tz is required for correct streak calendar days).
var user = new EventRequestUser {
   Id = "18",
   Email = "user@example.com",
   Tz = "Europe/London"
};

var request = new MetricsEventRequest {
   User = user,
   Value = 1,
   // Protects against duplicate events from the same flashcard
   IdempotencyKey = "flashcard-view-42"
};

var response = await trophy.Metrics.EventAsync("flashcards-flipped", request);

client = TrophyApiClient::Client.new(
  :api_key => ENV["TROPHY_API_KEY"]
)

# user.id is required. email and tz are optional but recommended
# (tz is required for correct streak calendar days).
result = client.metrics.event(
  :key => 'flashcards-flipped',
  :user => {
    :id => '18',
    :email => 'user@example.com',
    :tz => 'Europe/London'
  },
  :value => 1,
  :idempotencyKey => 'flashcard-view-42' # Protects against duplicate events from the same flashcard
)