// API REFERENCE

API Reference

Complete API documentation for programmatically submitting feedback.

Base URL

https://feedbackly.cc/api

Authentication

The API uses API keys for authentication. Pass the key in the request body:

{
  "api_key": "your_project_api_key",
  ...
}

Submit Feedback

POST/feedback

Submits new feedback to the project.

Request Body

Field	Type	Required	Description
api_key	string	Yes	Project API key
type	string	Yes	"bug" \| "idea" \| "other"
message	string	Yes	Feedback message text
email	string	No	User email
page_url	string	Yes	Page URL
screenshot	string	No	Base64 screenshot
metadata	object	Yes	user_agent, screen_size, timestamp

Example Request

curl -X POST https://feedbackly.cc/api/feedback \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "your_api_key",
    "type": "bug",
    "message": "Button doesn't work on mobile",
    "email": "user@example.com",
    "page_url": "https://example.com/checkout",
    "metadata": {
      "user_agent": "Mozilla/5.0...",
      "screen_size": "375x812",
      "timestamp": "2024-01-15T10:30:00Z"
    }
  }'

Response

{
  "success": true,
  "id": "550e8400-e29b-41d4-a716-446655440000"
}

Error Responses

Code	Description
400	Missing required fields
401	Invalid API key
403	Domain not allowed
429	Rate limit exceeded
500	Internal server error

Rate Limits

API limits depend on your plan:

Plan	Feedback/month
Free	50
Pro	500
Business	Unlimited