Complete guides and API reference

Documentation & Developer Guides

Everything you need to set up, configure, and optimize your geo-targeted link campaigns with GeoRedir.

Quick Start

Get started in 3 simple steps

Create your first geo-targeted smart link in under 5 minutes.

1

Create Your Account

Sign up for free and access your dashboard in seconds.

2

Create a Smart Link

Add your destination URLs and configure geo-targeting rules.

3

Share Your Link

Use your GeoRedir link in campaigns and start tracking clicks.

API Reference

RESTful API with code examples

Integrate GeoRedir into your workflow with our powerful API. Create and manage links programmatically.

Authentication

Generate an API key from your settings and use it in the X-API-Key header.

# Get your API key from: Settings → API Keys → Generate New Key
# All API requests must include the X-API-Key header

curl -X GET https://georedir.com/v1/links \
  -H "X-API-Key: gdr_your_api_key_here"

Create a Smart Link

Create a new geo-targeted link with multiple destination rules.

curl -X POST https://georedir.com/v1/links \
  -H "X-API-Key: gdr_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "EU Campaign",
    "slug": "eu-promo-2025",
    "description": "European promotion campaign",
    "rules": [
      {
        "priority": 1,
        "rule_type": "country",
        "conditions": {"countries": "GB,DE,FR"},
        "destination_url": "https://example.com/eu-offer",
        "weight": 1.0
      },
      {
        "priority": 2,
        "rule_type": "default",
        "conditions": {},
        "destination_url": "https://example.com/global",
        "weight": 1.0
      }
    ]
  }'

List All Links

Retrieve all your smart links with pagination support.

curl -X GET "https://georedir.com/v1/links?skip=0&limit=10" \
  -H "X-API-Key: gdr_your_api_key_here"

# Response:
# [
#   {
#     "id": 1,
#     "name": "EU Campaign",
#     "slug": "eu-promo-2025",
#     "is_active": true,
#     "total_clicks": 1250,
#     "last_click_at": "2025-01-27T10:30:00Z",
#     "rules": [...]
#   }
# ]

Get Link Analytics

Retrieve detailed analytics for a specific link including top countries and devices.

curl -X GET "https://georedir.com/v1/analytics/123?days=30" \
  -H "X-API-Key: gdr_your_api_key_here"

# Response:
# {
#   "link_id": 123,
#   "link_name": "EU Campaign",
#   "slug": "eu-promo-2025",
#   "stats": {
#     "total_clicks": 1250,
#     "unique_countries": 15,
#     "unique_devices": 3
#   },
#   "top_countries": [
#     {"country": "GB", "clicks": 450},
#     {"country": "DE", "clicks": 320}
#   ],
#   "top_devices": [
#     {"device_type": "mobile", "clicks": 800}
#   ]
# }

Update Link

Update link properties and rules.

curl -X PATCH https://georedir.com/v1/links/123 \
  -H "X-API-Key: gdr_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "EU Campaign - Updated",
    "is_active": true,
    "rules": [
      {
        "priority": 1,
        "rule_type": "country",
        "conditions": {"countries": "GB,DE,FR,ES,IT"},
        "destination_url": "https://example.com/new-eu-offer",
        "weight": 1.0
      }
    ]
  }'

Delete a Link

Permanently delete a smart link and all its associated data.

curl -X DELETE https://georedir.com/v1/links/123 \
  -H "X-API-Key: gdr_your_api_key_here"

# Response:
# {
#   "message": "Link deleted successfully"
# }

Complete interactive API reference with code examples in multiple languages

Real-World Examples

Common use cases and implementations

Learn from real-world scenarios and implement proven strategies for your campaigns.

iGaming Compliance Routing

Route players to licensed operators based on jurisdiction with automatic compliance checks.

Example

Route UK traffic to UK-licensed operators, EU traffic to MGA-licensed sites, and block restricted countries.

Multi-Network Affiliate Arbitrage

Test different affiliate networks and offers by geography to maximize EPC.

Example

Send US traffic to Network A, EU traffic to Network B, and use A/B testing within each region.

Mobile App Install Campaigns

Route iOS users to App Store, Android to Google Play, and desktop to landing pages.

Example

Detect device OS and automatically send users to the appropriate app store with tracking parameters.

Localized Pricing Funnels

Show region-specific pricing and payment methods based on user location.

Example

Route EU traffic to EUR pricing, US to USD pricing, and emerging markets to PPP-adjusted offers.

Best Practices

Tips for campaign success

Follow these best practices to maximize performance and avoid common pitfalls.

Always Set a Default URL

Ensure users from unmatched countries still reach a relevant destination.

Test Your Links Regularly

Use VPN or proxy testing to verify your geo-targeting rules work correctly.

Use Descriptive Link Names

Name your links clearly (e.g., "Q1-2025-VPN-EU-Campaign") for easy management.

Monitor Performance Daily

Check your analytics dashboard regularly to catch issues and optimize underperforming rules.

Implement Conversion Tracking

Add conversion pixels or postback URLs to track actual revenue, not just clicks.

Use Custom Domains for Trust

Branded domains improve click-through rates and build user confidence.

Ready to get started?

Create your account and start building geo-targeted campaigns in minutes.

Need help? Our support team is here to assist you.