Integrate Litmusly's AI-powered user testing directly into your applications and workflows.
The Litmusly API is organized around REST. It has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
https://api.litmusly.com/v1/testsThe Litmusly API uses API keys to authenticate requests. You can view and manage your API keys in the Litmusly Dashboard. Your API keys carry many privileges, so be sure to keep them secure.
Authorization: Bearer YOUR_API_KEYThe Litmusly API returns responses in JSON format. Successful responses include a data object with the requested information. Error responses include an error object with details about what went wrong.
{ "data": { ... }, "meta": { ... } }The Litmusly API implements rate limiting to ensure stability and fair usage. Rate limits vary based on your plan. The API returns headers with your current rate limit status.
X-RateLimit-Limit: 100X-RateLimit-Remaining: 98Log in to your Litmusly dashboard and navigate to the API section to create your API key.
YOUR_API_KEYUse your API key to make a simple request to verify your setup.
curl -X GET "https://api.litmusly.com/v1/tests" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Create a test by sending a POST request with your test configuration.
curl -X POST "https://api.litmusly.com/v1/tests" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "My First Test", "url": "https://example.com", "personas": ["power_user", "novice"]}'Retrieve a list of all tests in your account, with optional filtering.
GET /v1/testsCreate a new test with specified parameters and personas.
POST /v1/testsRetrieve details for a specific test by ID.
GET /v1/tests/:idOur JavaScript SDK makes it easy to integrate Litmusly into your web applications and Node.js services.
npm install @litmusly/sdkOur Python SDK allows you to integrate Litmusly into your Python applications and services.
pip install litmuslyWebhooks allow your application to receive real-time notifications when events occur in your Litmusly account. Instead of polling the API, your application can be notified immediately when a test is completed, feedback is generated, or other events occur.
{
"event": "feedback.created",
"data": {
"id": "fb_123456789",
"test_id": "test_987654321",
"persona": "power_user",
"content": "The navigation was intuitive, but I found the checkout process confusing.",
"sentiment": "mixed",
"created_at": "2023-05-15T14:32:21Z"
}
}Our developer support team is ready to help you integrate Litmusly into your applications.