Developer API Reference

Returns a paginated list of all dynamic QR codes owned by the key's user account.

Query Parameters

• ●limit (optional) - Number of results to return (default 50, max 100)
• ●offset (optional) - Number of results to skip (default 0)

Response Example (200 OK)

{
  "success": true,
  "data": [
    {
      "id": "b2d28fcd-a043-424a-9cfa-13fbc1379ea0",
      "short_id": "x8y2b3c4",
      "name": "Spring Campaign",
      "target_url": "https://example.com/promo",
      "is_dynamic": true,
      "expires_at": null,
      "created_at": "2026-07-30T04:14:00.000Z",
      "short_url": "http://localhost:3000/q/x8y2b3c4"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 50,
    "offset": 0
  }
}

Create a new dynamic QR code routing through Wedjx redirection system.

Request Body (JSON)

• ●target_url (required, string) - Destination URL
• ●name (optional, string) - Display name for organization
• ●password (optional, string) - Setup password restriction
• ●expires_at (optional, string) - Date-time string for expiration

Response Example (201 Created)

{
  "success": true,
  "data": {
    "id": "f83a6de4-c112-42da-aa1e-089c8a7cde12",
    "short_id": "a7b3c2d1",
    "name": "API Generated QR",
    "target_url": "https://example.com/docs",
    "is_dynamic": true,
    "expires_at": "2026-12-31T23:59:59.000Z",
    "created_at": "2026-07-30T04:14:00.000Z",
    "short_url": "http://localhost:3000/q/a7b3c2d1"
  }
}

Get structured count aggregations of scan device types, countries, browsers, operating systems, and the 20 most recent scan activities for the past 365 days.

Response Example (200 OK)

{
  "success": true,
  "data": {
    "qr_id": "b2d28fcd-a043-424a-9cfa-13fbc1379ea0",
    "short_id": "x8y2b3c4",
    "name": "Spring Campaign",
    "total_scans": 1420,
    "analytics_period_days": 365,
    "by_country": {
      "Egypt": 900,
      "United States": 420,
      "Unknown": 100
    },
    "by_device": {
      "Desktop": 800,
      "iOS": 500,
      "Android": 120
    },
    "by_browser": {
      "Chrome": 900,
      "Safari": 400,
      "Firefox": 120
    },
    "by_os": {
      "Windows": 800,
      "iOS": 500,
      "Linux": 120
    },
    "recent_scans": [
      {
        "scanned_at": "2026-07-30T04:14:00.000Z",
        "country": "Egypt",
        "device": "iOS",
        "browser": "Safari",
        "os": "iOS"
      }
    ]
  }
}