Public API: read campaign and user statistics from your frontend

​

Generate and manage your Public token

1

Go to Settings

Go to Settings → Public API.

2

Generate a token

If no token exists, select Generate token.

3

Copy the token

Copy the value shown under Public token and use it in your requests.

4

Revoke if needed

To immediately invalidate the token, select Revoke token. You can generate a new token at any time.

​

Authentication and request format

• pid — Campaign ID (string or number).
• account — A unique identifier for the user within your system (for example, user ID or email hash).
• platform — A short name representing your organization or platform.
• pub — Your Public token.

​

API methods

​

GET /public/api/user

{
  "pid": "string",
  "account": "string",
  "platform": "string",
  "pub": "string"
}

• pid: The campaign ID.
• account: The user’s ID.
• platform: The user’s platform.
• pub: Your Public token.

{
  "id": "string",
  "name": "string",
  "ref_id": "string",
  "ref_xp": 0,
  "ugc_xp": 0,
  "xp": 0,
  "xp_mul": 0,
  "rank": 0
}

​

GET /public/api/user/refs

{
  "pid": "string",
  "account": "string",
  "platform": "string",
  "pub": "string"
}

• pid: The campaign ID.
• account: The user’s ID.
• platform: The user’s platform.
• pub: Your Public token.

{
  "id": "string",
  "name": "string",
  "ref_id": "string",
  "ref_xp": 0,
  "ugc_xp": 0,
  "xp": 0,
  "xp_mul": 0,
  "rank": 0,
  "referrals": [
    {
      "id": "string",
      "name": "string",
      "valid": true,
      "ref_xp": 0,
      "xp": 0,
      "cts": "2024-01-01T00:00:00Z"
    }
  ]
}

​

GET /public/api/entries/count

{
  "pid": "string",
  "platform": "string",
  "pub": "string"
}

• pid: The campaign ID.
• platform: The user’s platform.
• pub: Your Public token.

{ "count": 0 }

​

GET /public/api/campaign/stats

{
  "pid": "string",
  "platform": "string",
  "pub": "string"
}

• pid: The campaign ID.
• platform: The user’s platform.
• pub: Your Public token.

{
  "participants": 0,
  "tasks_completed": 0,
  "quests_completed": 0,
  "xp": 0
}

​

Security notes

• The Public token is safe to use on the frontend for the endpoints listed here, but treat it as a secret for your organization. Rotate it by using Revoke token and Generate token if it is exposed.
• Do not use the Public API for any sensitive queries. Use the server-side API for those cases.

​

Troubleshooting

• 401/403: Verify pub is present and correct. If you revoked the token, generate a new one and update your site.
• 429: Reduce frequency of calls or cache responses on the client.
• CORS: Ensure you are calling the correct base domain for your environment.