Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/dishant0406/quickleap/llms.txt

Use this file to discover all available pages before exploring further.

The Quickleap API provides programmatic access to manage domain redirects, analytics, and rules. Build powerful integrations to automate redirect workflows and access comprehensive analytics data.

​
Base URL

All API requests are made to: 
https://api.quickleap.io
The API uses standard HTTP methods and returns JSON responses.

​
Available resources

​
Redirects

Manage domain redirects with full control over redirect types, path forwarding, query forwarding, and analytics sampling. Key endpoints:
  • POST /add-redirect - Create a new redirect
  • GET /get-redirects/me - Get all redirects for authenticated user
  • PUT /update/:id - Update an existing redirect
  • DELETE /delete-redirect/:id - Delete a redirect
  • POST /verify-domain - Verify domain ownership status

​
Analytics

Access comprehensive analytics data for your redirects, including traffic patterns, geographic distribution, device information, and more. Key endpoints:
  • GET /analytics/redirect/:redirectId/stats/basic - Basic statistics
  • GET /analytics/redirect/:redirectId/stats/time - Time-based analytics
  • GET /analytics/redirect/:redirectId/stats/geo - Geographic data
  • GET /analytics/redirect/:redirectId/stats/devices - Device information
  • GET /analytics/redirect/:redirectId/stats/referrers - Referrer data
  • GET /analytics/redirect/:redirectId/dashboard - Dashboard summary
  • GET /analytics/redirect/:redirectId/hits - Raw hit data with pagination

​
Rules

Create conditional redirects based on user attributes like location, device, browser, referrer, and time. Key endpoints:
  • GET /rules/redirect/:redirectId - Get all rules for a redirect
  • POST /rules/redirect/:redirectId - Create a new rule
  • PUT /rules/:ruleId - Update a rule
  • DELETE /rules/:ruleId - Delete a rule
  • PUT /rules/redirect/:redirectId/reorder - Reorder rule priorities
  • POST /rules/:ruleId/duplicate - Duplicate a rule
  • GET /rules/attributes - Get available attributes and operators

​
Response format

All API responses return JSON with the following structure:

​
Success responses

{
  "data": {
    // Response data
  }
}
For list endpoints, responses include the requested data directly: 
{
  "id": "redirect_123",
  "fromDomain": "example.com",
  "toDomain": "https://newsite.com",
  "redirectType": "permanent",
  "pathForwarding": true,
  "queryForwarding": true,
  "samplingRate": 1
}

​
Error responses

Error responses include an HTTP status code and error details: 
{
  "error": {
    "message": "Description of the error",
    "code": "ERROR_CODE",
    "field": "fieldName" // Optional, for validation errors
  }
}

​
HTTP status codes

The API uses standard HTTP status codes:
Status CodeDescription
200Success - Request completed successfully
201Created - Resource created successfully
400Bad Request - Invalid request parameters
401Unauthorized - Missing or invalid authentication
403Forbidden - Insufficient permissions
404Not Found - Resource not found
422Unprocessable Entity - Validation error
429Too Many Requests - Rate limit exceeded
500Internal Server Error - Server error

​
Error handling

Handle errors gracefully by checking the HTTP status code and parsing the error response: 
try {
  const response = await fetch('https://api.quickleap.io/get-redirects/me', {
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    }
  });

  if (!response.ok) {
    const error = await response.json();
    console.error('API Error:', error.error.message);
    throw new Error(error.error.message);
  }

  const data = await response.json();
  return data;
} catch (error) {
  console.error('Request failed:', error);
}

​
Rate limiting

The API implements rate limiting to ensure fair usage across all users. Rate limits vary by plan:
Rate limit information is included in response headers:
  • X-RateLimit-Limit - Maximum requests allowed
  • X-RateLimit-Remaining - Remaining requests in current window
  • X-RateLimit-Reset - Time when the rate limit resets (Unix timestamp)
When you exceed the rate limit, you’ll receive a 429 Too Many Requests response: 
{
  "error": {
    "message": "Rate limit exceeded. Please try again later.",
    "code": "RATE_LIMIT_EXCEEDED"
  }
}
Implement exponential backoff when you receive rate limit errors to avoid being temporarily blocked.

​
Pagination

Endpoints that return lists support pagination using query parameters:
ParameterDescriptionDefault
pagePage number (1-indexed)1
limitItems per page (max 100)20
Example request: 
GET /analytics/redirect/123/hits?page=2&limit=50
Paginated responses include metadata: 
{
  "data": [...],
  "pagination": {
    "page": 2,
    "limit": 50,
    "total": 243,
    "totalPages": 5
  }
}

​
Query parameters

Many analytics endpoints support filtering by date range:
ParameterDescriptionFormat
startStart date for filteringISO 8601 (e.g., 2024-01-01T00:00:00Z)
endEnd date for filteringISO 8601 (e.g., 2024-01-31T23:59:59Z)
intervalTime interval for time-series datahour, day, week, month
Example with date filtering: 
GET /analytics/redirect/123/stats/time?start=2024-01-01T00:00:00Z&end=2024-01-31T23:59:59Z&interval=day

​
Content type

All requests must include the Content-Type: application/json header. The API accepts and returns JSON only.
Request and response data is automatically trimmed of leading and trailing whitespace to prevent common formatting issues.

​
Next steps

Authentication

Learn how to authenticate API requests

Redirects

Manage domain redirects

Analytics

Access analytics data

Rules

Create conditional redirects

Build docs developers (and LLMs) love

Get started for freeTalk to us