Direct Feedback URLs
Create direct feedback URLs that users can visit to provide ratings on your documentation. This is perfect for simple "Rate Us" links or when you want users to provide feedback without visiting your documentation first.
URL Format
Use this URL format to create direct feedback links:
https://your-domain.com/feedback/{projectUid}/{source}?rating={rating}URL Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| projectUid | String | Required | Your project's unique identifier from the dashboard. |
| source | String | Required | Source identifier (e.g., "github", "docs", "website", "email"). |
| rating | Number (1-10) | Optional | Query parameter to pre-select a specific rating. If omitted, users can choose any rating. |
Examples
Simple "Rate Us" Link
Create a simple link that takes users to your feedback page where they can choose their own rating:
[Rate this documentation](https://your-domain.com/feedback/PROJECT_UID/website)
Pre-selected Rating Links
Create links that pre-select a specific rating:
// High rating (8/10) [Rate 8/10](https://your-domain.com/feedback/PROJECT_UID/github?rating=8) // Low rating (3/10) [Rate 3/10](https://your-domain.com/feedback/PROJECT_UID/docs?rating=3) // Medium rating (6/10) [Rate 6/10](https://your-domain.com/feedback/PROJECT_UID/website?rating=6)
Multiple Rating Options
Provide multiple rating options for users to choose from:
## How helpful was this documentation? [1/10](https://your-domain.com/feedback/PROJECT_UID/docs?rating=1) | [2/10](https://your-domain.com/feedback/PROJECT_UID/docs?rating=2) | [3/10](https://your-domain.com/feedback/PROJECT_UID/docs?rating=3) | [4/10](https://your-domain.com/feedback/PROJECT_UID/docs?rating=4) | [5/10](https://your-domain.com/feedback/PROJECT_UID/docs?rating=5) | [6/10](https://your-domain.com/feedback/PROJECT_UID/docs?rating=6) | [7/10](https://your-domain.com/feedback/PROJECT_UID/docs?rating=7) | [8/10](https://your-domain.com/feedback/PROJECT_UID/docs?rating=8) | [9/10](https://your-domain.com/feedback/PROJECT_UID/docs?rating=9) | [10/10](https://your-domain.com/feedback/PROJECT_UID/docs?rating=10)
Use Cases
Simple "Rate Us" Button
Add a single link that takes users to your feedback page where they can provide any rating.
Email Signatures
Include feedback links in email signatures or support communications.
Social Media
Share feedback links on social media or in community forums.
Quick Feedback
Provide quick access to feedback without requiring users to visit your main documentation.
Best Practices
- Use descriptive sources: Use meaningful source identifiers like "github", "docs", "website", or "email"
- Keep URLs short: Consider using URL shorteners for very long feedback URLs
- Test your links: Always test feedback URLs to ensure they work correctly
- Provide context: Include clear text around your feedback links explaining what users are rating
Ready to Create Feedback Links?
Create a project to get your project UID and start creating direct feedback URLs.
Create Project