by-smartlink.com

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "Main destination URL. Required unless using A/B testing (abVariants)."
    },
    "title": {
      "type": "string",
      "description": "A descriptive name for this link (e.g., \"Back to School - Facebook Campaign\")"
    },
    "utmSource": {
      "type": "string",
      "description": "UTM source parameter (e.g., \"facebook\", \"google\", \"newsletter\")"
    },
    "utmMedium": {
      "type": "string",
      "description": "UTM medium parameter (e.g., \"cpc\", \"email\", \"social\")"
    },
    "utmCampaign": {
      "type": "string",
      "description": "UTM campaign name (e.g., \"back-to-school-2026\", \"summer-sale\")"
    },
    "geoRules": {
      "type": "array",
      "description": "Geo-targeting rules: route users from specific countries to different URLs.",
      "items": {
        "type": "object",
        "properties": {
          "countries": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "ISO 3166-1 alpha-2 country codes (e.g., [\"SA\", \"AE\"] for Saudi Arabia and UAE)"
          },
          "targetUrl": {
            "type": "string",
            "description": "The URL to redirect users from these countries to"
          }
        },
        "required": [
          "countries",
          "targetUrl"
        ]
      }
    },
    "deviceRules": {
      "type": "object",
      "description": "Device-based routing. Route mobile users to one URL and desktop users to another.",
      "properties": {
        "mobile": {
          "type": "string",
          "description": "URL for mobile device users"
        },
        "desktop": {
          "type": "string",
          "description": "URL for desktop users"
        },
        "tablet": {
          "type": "string",
          "description": "URL for tablet users"
        }
      }
    },
    "languageRules": {
      "type": "array",
      "description": "Language-based routing using browser language settings.",
      "items": {
        "type": "object",
        "properties": {
          "language": {
            "type": "string",
            "description": "ISO 639-1 language code (e.g., \"ar\", \"fr\", \"es\")"
          },
          "targetUrl": {
            "type": "string",
            "description": "URL to show users whose browser language matches"
          }
        }
      }
    },
    "abVariants": {
      "type": "array",
      "description": "A/B test variants. Provide 2+ URLs to split traffic and find the best-performing one.",
      "items": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "description": "Destination URL for this variant"
          },
          "name": {
            "type": "string",
            "description": "Name for this variant (e.g., \"Version A - Red Button\")"
          },
          "weight": {
            "type": "number",
            "description": "Traffic percentage for this variant (e.g., 50 for 50%)"
          }
        },
        "required": [
          "url"
        ]
      }
    },
    "enableBotProtection": {
      "type": "boolean",
      "description": "Enable automatic bot detection to block scrapers and fake ad clicks. Recommended for paid ad campaigns."
    },
    "customAlias": {
      "type": "string",
      "description": "Custom short code (e.g., \"summer26\" → by-smartlink.com/summer26). Must be 3-50 alphanumeric characters."
    }
  }
}