> For the complete documentation index, see [llms.txt](https://docs.claimr.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.claimr.io/descriptions-creation-usage-tags.md).
# Descriptions: creation, usage, tags
## What are Descriptions?
Descriptions are text fields used across claimr modules, including campaigns, groups, contests, tasks, and forms. They allow you to add instructions, tags, contextual details, and media that participants see when interacting with your campaign.
While the text editor looks the same across modules, each description field is specific to its context (for example, campaign description vs. task description).
## Description editor
Each description field opens a text editor where you can:
* Format text (fonts, styles, alignment, sub/superscript)
* Change text and background colors
* Add images
* Add links
After editing, click Save to apply your changes. Use the Preview option to check how your description will look for participants.
### Dark and Light modes
Descriptions support both Light and Dark modes.
* The default text color is black.
* When using Dark mode, black text may not be visible. In this case, you should manually select a light or bright text color to ensure readability.
* The editor does not automatically adjust text colors — you are responsible for setting colors that are visible in both modes.
## Description tags
Descriptions support tags, which allow you to insert dynamic values. Tags personalize the experience for each participant by displaying campaign- or user-specific data.
### How to use tags
1. Insert a tag directly into the text editor
2. Save your changes.
3. When participants view the campaign, the tag will be replaced with the correct value.
### Available tags
### 1. User-related tags
Display information about the current user and their profile attributes.
* {{claimr\_id}}: Displays the unique claimr user ID.
* {{user\_name}}: Displays the user’s profile name.
* {{evm\_address}}: Shows the user’s connected EVM wallet address (if available).
* {{ref\_name}}: Displays the name of the user who referred the current user.
* {{team\_name}}: Shows the name of the team the user belongs to.
* {{rank}}: Displays the user’s current rank in the campaign.
* {{leaderboard\_position}}: Shows the user’s position on the campaign leaderboard.
* {{campaign\_progression}}: Displays the user’s campaign progression status.
### 2. Points-related tags
These tags display information about experience points (XP) and other custom point types.
* {{total\_xp}}: Displays the user’s total accumulated experience points (XP) in the campaign.
* {{xp\_alias}}: Shows the campaign’s custom XP label.
* {{ref\_xp}}: Displays the XP earned from referrals.
* {{task\_xp}}: Displays the XP earned from a specific (selected) task.
* {{points\_\[PointID]\_XP}}: Displays the user’s balance of an additional point type. This tag is specific to the customizable points you created. The PointID must match the ID you entered manually when creating the point.
### 3. Campaign-level tags
These tags provide general statistics about the campaign.
* {{participants}}: Displays the total number of participants in the campaign.
### 4. Referral-related tags
Track user referrals and rewards earned through referrals.
* {{ref\_count}}: Shows the total number of referrals the user has made.
* {{ref\_xp}}: Displays the XP earned from referrals.
### 5. Quest and task-related tags
Show quest and task completions, as well as rewards.
* {{completed\_quests}}: Shows how many quests the user has completed.
* {{quests}}: Displays the total number of quests available in the campaign.
* {{max\_quest\_reward}}: Displays the maximum reward available for a single quest. Works only within the selected quest.
* {{task\_xp}}: Displays the XP earned from a specific (selected) task.
### 6. API task–specific tags
Specific to API tasks and display scores, counts, and requirements.
* {{api\_task\_total\_score}}: Shows the total score across all API tasks.
* {{api\_task\_count}}: Displays the number of API tasks completed.
* {{api\_task\_user\_score}}: Shows the user’s score for an API task.
* {{api\_task\_user\_total\_count}}: Displays the total number of API tasks completed by the user.
* {{api\_task\_min\_value}}: Displays the minimum value required for an API task.
### 7. Event-related tags
These tags display data collected from event-based tracking.
* {{events\_value}}: Displays the value from event-based tracking.
* {{events\_max\_value}}: Shows the maximum event value reached.
* {{events\_last\_value}}: Displays the last recorded event value.
* {{events\_count}}: Shows the total number of events recorded.
* {{events\_max\_count}}: Shows the maximum number of events reached.
* {{events\_last\_count}}: Shows the last recorded event count.
Make sure all tags are entered exactly as written to be recognized.
### Usage across claimr
Descriptions appear in multiple places but follow the same principles. For details on where each description is used, see:
* [Campaign settings](/campaigns/general-campaign-settings.md)
* [Group description](/groups/group-settings.md)
* [Quest settings](/quests/quest-settings.md)
* [Task settings](/tasks/task-settings.md)
* [Form description ](/forms/form-settings.md)
* [Pop-ups](/pop-ups.md)
* [Challenges](/extra/challenges.md)
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.claimr.io/descriptions-creation-usage-tags.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.