WOGAA Documentation

Appearance

Support ​

Need help? We're here to assist you.

Troubleshooting ​

Common Issues ​

SDK Not Loading ​

Symptoms:

  • No console output from SDK
  • Events not being tracked
  • SDK initialization fails

Diagnostics:

javascript
// Check if SDK loaded
console.log("SDK loaded:", typeof YourOrgSDK !== "undefined");

// Enable debug mode
const sdk = new SDK({
  apiKey: "key",
  debugMode: true,
  verboseLogging: true,
});

Solutions:

  1. Verify API key is correct
  2. Check network connectivity
  3. Ensure domain is whitelisted
  4. Review browser console for errors
  5. Check CDN/npm package is accessible

Events Not Appearing in Dashboard ​

Checklist:

  • [ ] Using correct API key
  • [ ] Correct environment (test/production)
  • [ ] Wait 1-2 minutes for data processing
  • [ ] Check date range filter in dashboard
  • [ ] Verify events are being sent (Network tab)

Debug:

javascript
sdk.on("event_tracked", (event) => {
  console.log("✓ Event tracked:", event);
});

sdk.on("event_failed", (error) => {
  console.error("✗ Event failed:", error);
});

CORS Errors ​

Error message:

Access to fetch at 'https://api.yourorg.com/...' has been blocked by CORS policy

Solutions:

  1. Add your domain to allowed domains in admin portal
  2. Wait 5-10 minutes for changes to propagate
  3. Clear browser cache
  4. Verify protocol (http vs https) matches registration

High Bundle Size ​

Check current size:

bash
# For web apps
npm run build -- --analyze

# Check specific import
import { Analyzer } from 'webpack-bundle-analyzer'

Solutions:

javascript
// ✅ Use tree shaking
import { Analytics } from "@your-org/web-sdk/modules";

// ✅ Lazy load
const SDK = lazy(() => import("@your-org/web-sdk"));

// ✅ Use CDN instead of npm
<script src="https://cdn.yourorg.com/sdk/v1/sdk.min.js"></script>;

Platform-Specific Issues ​

Web SDK ​

Mobile SDKs ​

FAQ ​

General Questions ​

What's the difference between Test and Production environments?
  • Test Environment: For development and testing. Data is kept separate and can be cleared.
  • Production Environment: For live applications. Data is retained according to your retention policy.

Use different API keys for each environment.

How long does it take for data to appear?
  • Real-time metrics: 30-60 seconds
  • Historical reports: 2-5 minutes
  • Complex aggregations: Up to 15 minutes

If data doesn't appear after 15 minutes, check your configuration.

Do I need different SDKs for web and mobile?

Yes. Use:

  • Web SDK for websites and web applications
  • iOS SDK for native iOS apps
  • Android SDK for native Android apps
  • React Native SDK for React Native apps
  • etc.

Each SDK is optimized for its platform.

Can I use the SDK offline?

Yes! All SDKs support offline mode:

  • Events are queued locally when offline
  • Automatically sent when connection is restored
  • Queue size is configurable
javascript
const sdk = new SDK({
  apiKey: "key",
  offlineQueueSize: 100, // Max events to queue
});
Is the SDK open source?

The SDK is proprietary but we provide:

  • Comprehensive documentation
  • Example projects
  • TypeScript definitions
  • Source maps for debugging

Technical Questions ​

What browsers are supported?

Web SDK supports:

  • Chrome (last 2 versions)
  • Firefox (last 2 versions)
  • Safari (last 2 versions)
  • Edge (last 2 versions)
  • IE11+ (with polyfills)

Mobile browsers:

  • iOS Safari 12+
  • Chrome on Android 5+
What's the SDK bundle size?

Web SDK:

  • Full: ~45KB (~15KB gzipped)
  • Core only: ~25KB (~8KB gzipped)

Mobile SDK:

  • iOS: ~2.5MB framework
  • Android: ~3MB AAR
Does the SDK support TypeScript?

Yes! Full TypeScript definitions are included:

typescript
import SDK, { SDKConfig, EventData } from "@your-org/web-sdk";

const config: SDKConfig = {
  apiKey: "key",
  environment: "production",
};
Can I self-host the SDK?

Yes, for web SDK:

  1. Download from npm: npm install @your-org/web-sdk
  2. Host the built file on your server
  3. Reference it in your HTML
html
<script src="https://your-server.com/assets/sdk.min.js"></script>

Note: You still need an API key and our backend services.

Privacy & Security ​

Is the SDK GDPR compliant?

Yes. The SDK provides tools for GDPR compliance:

javascript
// Require consent
if (userConsented) {
  sdk.initialize();
}

// Opt-out
sdk.optOut();

// Delete user data
sdk.deleteUserData(userId);

// Anonymize IP
const sdk = new SDK({
  apiKey: "key",
  anonymizeIP: true,
});

You are responsible for obtaining user consent and managing data according to GDPR requirements.

How is data transmitted?
  • Encryption: TLS 1.2+ (HTTPS only)
  • Authentication: API key + signature
  • Validation: Server-side input validation
  • Privacy: Optional IP anonymization
Where is data stored?

Data is stored in secure data centers with:

  • Encryption at rest
  • Regular backups
  • Access controls
  • Compliance certifications

Contact support for specific datacenter locations.

Contact Support ​

Before Contacting ​

Please have ready:

  • API key (last 4 characters only)
  • SDK version
  • Platform (web/iOS/Android/etc.)
  • Description of issue
  • Steps to reproduce
  • Error messages/logs

Support Channels ​

Email Support ​

📧 support@yourorg.com

Response time:

  • Critical: 2-4 hours
  • High: 8-12 hours
  • Normal: 1-2 business days

Developer Forum ​

💬 community.yourorg.com

Get help from community and team members.

GitHub Issues ​

🐛 github.com/your-org/sdk

For bug reports and feature requests.

Live Chat ​

Available for enterprise customers.

Emergency Support ​

For production outages:

Community ​

Resources ​

Social Media ​

Service Status ​

Check current service status:

Subscribe to status updates for incidents and maintenance.

Documentation Feedback ​

Found an error in docs?

Released under the MIT License.

Copyright © 2024-present