Enterprise Reporting

​

Overview

​

Key Reporting Capabilities

​

Platform Analytics Dashboard

• User Engagement Metrics: Track active users, session duration, and user behavior patterns
• Challenge Performance: Monitor challenge completion rates, participation levels, and user progress
• Reward Distribution: Analyze reward redemption patterns and inventory management
• Achievement Tracking: Measure achievement completion rates and user progression

​

Available Metrics & KPIs

​

Analytics API

​

Users Overview Endpoint

const url = new URL('https://your-subdomain.nudj.cx/api/v2/analytics/users/overview');
url.search = new URLSearchParams({
  communityId: 'your-community-id',
  limit: '50',
  skip: '0',
  sort: 'createdAt:desc'
}).toString();

const response = await fetch(url.toString(), {
  headers: {
    'x-api-token': 'your-api-token',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log('User Analytics:', data);

​

Response Format

{
  "totalCount": 1250,
  "edges": [
    {
      "userId": "507f1f77bcf86cd799439011",
      "username": "john_doe",
      "email": "john@example.com",
      "profilePictureUrl": "https://cdn.nudj.cx/avatars/john.jpg",
      "points": 1250,
      "createdAt": "2025-01-15T10:30:00Z",
      "latestVisit": "2025-01-25T14:20:00Z",
      "challengesStarted": 15,
      "challengesCompleted": 12,
      "challengesInProgress": 3,
      "achievementsCompleted": 8,
      "externalUserId": "user_12345"
    }
  ]
}

​

Real-time vs Historical Reporting

​

Real-time Analytics

• Live Dashboard: Real-time updates of key performance indicators
• Event Streaming: Live tracking of user actions and engagement
• PostHog Integration: Real-time user behavior analytics with consent management

import { captureEvent, identifyUser } from '@nudj-digital/analytics';

// Track user actions in real-time
captureEvent('challenge_completed', {
  challengeId: 'challenge_123',
  userId: 'user_456',
  completionTime: 145,
  points_earned: 100
});

// Identify users for tracking
identifyUser('user_456', {
  email: 'user@example.com',
  community: 'gaming-community',
  tier: 'premium'
});

​

Historical Reporting

• Date Range Filtering: Query data for custom time periods
• Trend Analysis: Compare performance across different periods
• Cohort Analysis: Track user behavior over time

​

PowerBI Dashboard Integration

​

Features

• Custom Dashboards: Create tailored visualizations for your organization
• Advanced Analytics: Leverage PowerBI’s machine learning and predictive analytics
• Data Export: Export raw data for external analysis
• Automated Reports: Schedule and distribute reports automatically

​

Setup Process

1. Data Connection: Connect PowerBI to your Nudj analytics endpoints
2. Authentication: Configure API token authentication
3. Dashboard Creation: Build custom visualizations using your data
4. Report Scheduling: Set up automated report generation and distribution

​

Custom Report Building

​

Available Report Types

​

Platform Stats API

// Fetch platform-wide statistics
const statsUrl = new URL('https://your-subdomain.nudj.cx/api/v2/admin/platform-stats');
statsUrl.search = new URLSearchParams({
  organisationId: 'your-org-id',
  communityId: 'community-id',
  startDate: '2025-01-01',
  endDate: '2025-01-31'
}).toString();

const statsResponse = await fetch(statsUrl.toString(), {
  method: 'GET',
  headers: { 
    'x-api-token': 'YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const stats = await statsResponse.json();

// Available metrics:
console.log('Platform Stats:', {
  totalUsers: stats.totalUsers,
  activeUsers: stats.activeUsers,
  totalActionsPerformed: stats.totalActionsPerformed,
  challengeCompletionRate: stats.challengeCompletionRate,
  totalChallengesCompleted: stats.totalChallengesCompleted,
  totalChallengesStarted: stats.totalChallengesStarted,
  achievementsCompleted: stats.achievementsCompleted,
  achievementsInProgress: stats.achievementsInProgress,
  totalRewardsFromAchievements: stats.totalRewardsFromAchievements,
  totalRewardsPurchased: stats.totalRewardsPurchased
});

​

Export Formats and Scheduling

​

Supported Export Formats

• CSV: Structured data for spreadsheet analysis
• JSON: API-friendly format for system integration
• PDF: Formatted reports for presentations
• Excel: Advanced formatting with charts and pivot tables

​

Automated Scheduling

1. Report Configuration: Define metrics, filters, and format
2. Schedule Setup: Set frequency (daily, weekly, monthly)
3. Distribution List: Configure email recipients
4. Delivery Options: Email, webhook, or API endpoint delivery

const reportConfig = {
  name: 'Weekly Engagement Report',
  type: 'engagement_summary',
  schedule: 'weekly',
  format: 'pdf',
  filters: {
    communityId: 'community_123',
    dateRange: 'last_7_days'
  },
  recipients: ['manager@company.com', 'team@company.com']
};

// Schedule automated report
await scheduleReport(reportConfig);

​

Dashboard Configurations

​

Admin Dashboard Components

• Overview Cards: Key metrics at a glance
• Timeline Charts: Engagement trends over time
• User Activity Heatmaps: Visual representation of user behavior
• Performance Indicators: Real-time system health metrics

​

Customizable Views

​

Performance Metrics

​

System Performance Tracking

• API Response Times: Track endpoint performance
• User Session Metrics: Monitor engagement duration and patterns
• Challenge Completion Rates: Measure content effectiveness
• Error Rate Monitoring: Track and analyze system errors

​

User Experience Metrics

• Page Load Times: Frontend performance monitoring
• User Journey Analytics: Track navigation patterns
• Feature Adoption Rates: Measure new feature uptake
• Conversion Funnel Analysis: Optimize user flows

​

Data Privacy and Compliance

​

GDPR Compliance

• Consent Management: Integration with OneTrust for cookie consent
• Data Anonymization: Automatically anonymize sensitive user data
• Right to be Forgotten: Support for data deletion requests
• Data Portability: Export user data in standard formats

​

Security Features

• API Token Authentication: Secure access to analytics endpoints
• Role-based Access Control: Restrict data access by user role
• Audit Trails: Track all data access and modifications
• Data Encryption: All data encrypted in transit and at rest

​

Troubleshooting

​

Common Issues

​

Performance Optimization

• Data Filtering: Use appropriate filters to reduce dataset size
• Pagination: Implement pagination for large result sets
• Caching: Leverage built-in caching for frequently accessed data
• Scheduled Reports: Use off-peak hours for resource-intensive reports

​

Best Practices

​

Report Design

1. Define Clear Objectives: Establish what questions your reports should answer
2. Choose Relevant Metrics: Focus on KPIs that align with business goals
3. Use Appropriate Visualizations: Match chart types to data types
4. Provide Context: Include benchmarks and historical comparisons

​

Data Analysis

1. Regular Monitoring: Set up alerts for significant metric changes
2. Trend Analysis: Look for patterns over time rather than point-in-time snapshots
3. Segmentation: Analyze different user cohorts separately
4. Action-Oriented Insights: Ensure reports lead to actionable recommendations

​

Integration Examples

​

API Integration

import { ApiClient } from '@nudj-digital/api-client';

const client = new ApiClient({
  subdomain: 'your-subdomain',
  apiToken: process.env.NUDJ_API_TOKEN
});

// Fetch comprehensive analytics
async function getAnalytics(communityId: string) {
  const [users, stats] = await Promise.all([
    client.analytics.getUsersOverview({ communityId, limit: 100 }),
    client.admin.getPlatformStats({ communityId })
  ]);

  return {
    userMetrics: users,
    platformStats: stats,
    timestamp: new Date().toISOString()
  };
}

​

Support and Resources

​

Getting Started

1. Enable Enterprise Features: Contact your account manager to activate reporting features
2. API Access: Generate API tokens for your organization
3. Dashboard Setup: Configure your first analytics dashboard
4. PowerBI Integration: Set up PowerBI connectivity for advanced visualizations

​

Support Channels

• Technical Documentation: API Reference
• Account Support: Contact your dedicated customer success manager
• Community Forum: Join our Enterprise customer community
• Training Resources: Access our enterprise training portal