Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion admin-api/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: Authentication
description: Integrate securely with the Admin API using account-level admin API
keys transmitted in the `X-API-KEY` header.
og:description: Integrate securely with the Trophy Admin API using account-level
admin API keys transmitted in the `X-API-KEY` header.
admin API keys transmitted in the `X-API-KEY`
header.
icon: key
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create application API keys for users
openapi: "POST /application-api-keys"
openapi: POST /application-api-keys
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete application API keys
openapi: "DELETE /application-api-keys"
openapi: DELETE /application-api-keys
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/attributes/create-attributes.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create attributes
openapi: "POST /attributes"
openapi: POST /attributes
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/attributes/delete-attributes.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete attributes
openapi: "DELETE /attributes"
openapi: DELETE /attributes
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/attributes/get-an-attribute.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Get an attribute
openapi: "GET /attributes/{id}"
openapi: GET /attributes/{id}
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/attributes/list-attributes.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: List attributes
openapi: "GET /attributes"
openapi: GET /attributes
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/attributes/update-attributes.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Update attributes
openapi: "PATCH /attributes"
openapi: PATCH /attributes
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Submit a batch of metric events
openapi: "https://admin.trophy.so/v1/openapi post /metrics/events"
openapi: https://admin.trophy.so/v1/openapi post /metrics/events
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/leaderboards/create-leaderboards.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create leaderboards
openapi: "POST /leaderboards"
openapi: POST /leaderboards
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/leaderboards/delete-leaderboards.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete leaderboards
openapi: "DELETE /leaderboards"
openapi: DELETE /leaderboards
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/leaderboards/get-a-leaderboard.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Get a leaderboard
openapi: "GET /leaderboards/{id}"
openapi: GET /leaderboards/{id}
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/leaderboards/list-leaderboards.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: List leaderboards
openapi: "GET /leaderboards"
openapi: GET /leaderboards
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/leaderboards/update-leaderboards.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Update leaderboards
openapi: "PATCH /leaderboards"
openapi: PATCH /leaderboards
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/metrics/create-metrics.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create metrics
openapi: "POST /metrics"
openapi: POST /metrics
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/metrics/delete-metrics.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete metrics
openapi: "DELETE /metrics"
openapi: DELETE /metrics
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/metrics/get-a-metric.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Get a metric by ID
openapi: "GET /metrics/{id}"
openapi: GET /metrics/{id}
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/metrics/list-metrics.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: List metrics
openapi: "GET /metrics"
openapi: GET /metrics
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/metrics/update-metrics.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Update metrics
openapi: "PATCH /metrics"
openapi: PATCH /metrics
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/create-boosts.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create points boosts
openapi: "POST /points/{systemId}/boosts"
openapi: POST /points/{systemId}/boosts
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/create-levels.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create points levels
openapi: "POST /points/{systemId}/levels"
openapi: POST /points/{systemId}/levels
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/create-points-systems.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create points systems
openapi: "POST /points"
openapi: POST /points
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/create-points-triggers.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create points triggers
openapi: "POST /points/{systemId}/triggers"
openapi: POST /points/{systemId}/triggers
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/delete-boosts.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete multiple points boosts
openapi: "DELETE /points/{systemId}/boosts"
openapi: DELETE /points/{systemId}/boosts
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/delete-levels.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete multiple points levels
openapi: "DELETE /points/{systemId}/levels"
openapi: DELETE /points/{systemId}/levels
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/delete-points-systems.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete points systems
openapi: "DELETE /points"
openapi: DELETE /points
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/delete-points-triggers.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete points triggers
openapi: "DELETE /points/{systemId}/triggers"
openapi: DELETE /points/{systemId}/triggers
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/get-a-boost.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Get a points boost by ID
openapi: "GET /points/{systemId}/boosts/{id}"
openapi: GET /points/{systemId}/boosts/{id}
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/get-a-level.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Get a points level by ID
openapi: "GET /points/{systemId}/levels/{id}"
openapi: GET /points/{systemId}/levels/{id}
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/get-a-points-system.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Get a points system by ID
openapi: "GET /points/{id}"
openapi: GET /points/{id}
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/get-a-points-trigger.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Get a points trigger by ID
openapi: "GET /points/{systemId}/triggers/{id}"
openapi: GET /points/{systemId}/triggers/{id}
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/list-boosts.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: List points boosts
openapi: "GET /points/{systemId}/boosts"
openapi: GET /points/{systemId}/boosts
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/list-levels.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: List points levels
openapi: "GET /points/{systemId}/levels"
openapi: GET /points/{systemId}/levels
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/list-points-systems.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: List points systems
openapi: "GET /points"
openapi: GET /points
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/list-points-triggers.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: List points triggers
openapi: "GET /points/{systemId}/triggers"
openapi: GET /points/{systemId}/triggers
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/update-boosts.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Update multiple points boosts
openapi: "PATCH /points/{systemId}/boosts"
openapi: PATCH /points/{systemId}/boosts
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/update-levels.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Update multiple points levels
openapi: "PATCH /points/{systemId}/levels"
openapi: PATCH /points/{systemId}/levels
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/update-points-systems.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Update points systems
openapi: "PATCH /points"
openapi: PATCH /points
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/points/update-points-triggers.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Update points triggers
openapi: "PATCH /points/{systemId}/triggers"
openapi: PATCH /points/{systemId}/triggers
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/streaks/grant-freezes.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create streak freezes for multiple users
openapi: "POST /streaks/freezes"
openapi: POST /streaks/freezes
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/streaks/restore-streaks.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Restore streaks for multiple users
openapi: "POST /streaks/restore"
openapi: POST /streaks/restore
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/tenants/create-tenants.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create tenants
openapi: "POST /tenants"
openapi: POST /tenants
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/tenants/delete-tenants.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delete tenants
openapi: "DELETE /tenants"
openapi: DELETE /tenants
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/tenants/get-a-tenant.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Get a tenant
openapi: "GET /tenants/{id}"
openapi: GET /tenants/{id}
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/tenants/list-tenants.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: List tenants
openapi: "GET /tenants"
openapi: GET /tenants
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
2 changes: 1 addition & 1 deletion admin-api/endpoints/tenants/update-tenants.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Update tenants
openapi: "PATCH /tenants"
openapi: PATCH /tenants
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
6 changes: 4 additions & 2 deletions api-reference/authentication.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: Authentication
description: Authenticate with the Application API using user-scoped application
API keys transmitted in the `X-API-KEY` header.
API keys transmitted in the `X-API-KEY`
header.
og:description: Authenticate with the Trophy Application API using user-scoped
application API keys transmitted in the `X-API-KEY` header.
application API keys transmitted in the
`X-API-KEY` header.
icon: key
---

Expand Down
2 changes: 1 addition & 1 deletion api-reference/endpoints/achievements/all-achievements.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Get all achievements and their completion stats
openapi: "GET /achievements"
openapi: GET /achievements
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Mark an achievement as completed
openapi: "POST /achievements/{key}/complete"
openapi: POST /achievements/{key}/complete
---

import { RateLimitBadge } from "../../../components/rate-limit-badge.jsx";
Expand Down
Loading