Skip to main content

Device App Connection Summary

This endpoint provides connection summary reports for devices and applications within your system. It delivers aggregated statistics and overview data about device-to-application connections, helping administrators monitor connectivity patterns, identify issues, and analyze usage trends across their infrastructure.

Base URL: https://gate.zequenze.com/api/v1

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Overview

The Device App Connection Summary API provides comprehensive reporting capabilities for monitoring and analyzing the connectivity between devices and applications in your network infrastructure. This endpoint aggregates connection data to deliver high-level insights into your system's connectivity health.

This API is essential for network administrators, IT managers, and system operators who need to:

  • Monitor overall connectivity status across their device fleet
  • Identify connection patterns and usage trends
  • Track application adoption and device utilization
  • Generate reports for capacity planning and troubleshooting
  • Analyze connection performance metrics over time

The connection summary data helps organizations maintain optimal network performance by providing visibility into which devices are connecting to which applications, connection success rates, and potential connectivity issues that may require attention.

Endpoints

GET /device_app_connection_summary/

Description: Retrieves a comprehensive summary report of device-to-application connections across your infrastructure. This endpoint aggregates connection data to provide insights into connectivity patterns, success rates, and overall system health. Use this endpoint to generate dashboards, monitor network performance, and identify devices or applications that may require attention.

Use Cases:

  • Generate executive dashboards showing overall connectivity health
  • Monitor connection success rates and identify problematic devices or applications
  • Analyze usage patterns to inform capacity planning decisions
  • Create automated alerts based on connection thresholds
  • Produce periodic reports for network performance reviews

Full URL Example:

https://gate.zequenze.com/api/v1/device_app_connection_summary/?time_range=7d&status=active

Parameters:

Parameter Type In Required Description
time_range string query No Time period for the summary (1d, 7d, 30d, 90d). Defaults to 7d
status string query No Filter by connection status (active, inactive, failed, all). Defaults to all
device_type string query No Filter by device type (mobile, tablet, desktop, iot, server)
app_category string query No Filter by application category (productivity, security, communication, analytics)
organization_id integer query No Filter by specific organization ID
limit integer query No Number of results to return per page (default: 100, max: 1000)
offset integer query No Number of results to skip for pagination

cURL Example:

curl -X GET "https://gate.zequenze.com/api/v1/device_app_connection_summary/?time_range=30d&status=active" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "count": 1,
  "next": null,
  "previous": null,
  "summary_period": {
    "start_date": "2024-01-01T00:00:00Z",
    "end_date": "2024-01-31T23:59:59Z",
    "time_range": "30d"
  },
  "overall_metrics": {
    "total_devices": 1247,
    "active_devices": 1156,
    "total_applications": 89,
    "active_connections": 12489,
    "failed_connections": 234,
    "success_rate": 98.1,
    "average_connections_per_device": 10.8
  },
  "results": [
    {
      "connection_id": "conn_4f8b2a1c",
      "device_info": {
        "device_id": 12456,
        "device_name": "LAPTOP-SALES-001",
        "device_type": "desktop",
        "os_type": "windows",
        "last_seen": "2024-01-31T14:30:00Z"
      },
      "application_info": {
        "app_id": 789,
        "app_name": "Customer CRM",
        "app_category": "productivity",
        "version": "2.4.1"
      },
      "connection_metrics": {
        "total_sessions": 45,
        "successful_sessions": 44,
        "failed_sessions": 1,
        "success_rate": 97.8,
        "average_session_duration": 142,
        "total_data_transferred_mb": 234.7,
        "first_connection": "2024-01-02T09:15:00Z",
        "last_connection": "2024-01-31T16:22:00Z"
      },
      "organization": {
        "id": 101,
        "name": "Acme Corporation",
        "department": "Sales"
      },
      "status": "active",
      "health_score": 95.2
    }
  ],
  "aggregated_insights": {
    "top_applications": [
      {
        "app_name": "Customer CRM",
        "connection_count": 2847,
        "unique_devices": 234
      }
    ],
    "device_type_breakdown": {
      "desktop": 45.2,
      "mobile": 32.1,
      "tablet": 15.7,
      "iot": 7.0
    },
    "connection_trends": {
      "daily_average": 402.5,
      "peak_day": "2024-01-15",
      "peak_connections": 567
    }
  }
}

Response Codes:

Status Description
200 Success - Returns connection summary data
400 Bad Request - Invalid parameters or time range
401 Unauthorized - Invalid or missing authentication token
403 Forbidden - Insufficient permissions to access connection data
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error - Server-side processing error

Common Use Cases

Use Case 1: Daily Operations Dashboard

Generate a real-time dashboard for IT operations teams to monitor overall system health. Use the endpoint with time_range=1d and status=all to get current day statistics, connection success rates, and identify any devices experiencing connectivity issues.

Use Case 2: Monthly Performance Reports

Create comprehensive monthly reports for management by calling the endpoint with time_range=30d. The aggregated insights provide executive-level summaries of application usage, device adoption, and connectivity trends across the organization.

Use Case 3: Troubleshooting Connection Issues

When users report connectivity problems, filter by specific device_type or app_category with status=failed to quickly identify patterns in connection failures and prioritize remediation efforts.

Use Case 4: Capacity Planning Analysis

Use the endpoint with longer time ranges (time_range=90d) to analyze connection trends and device growth patterns. The metrics help inform infrastructure scaling decisions and application deployment strategies.

Use Case 5: Security Monitoring

Monitor for unusual connection patterns by regularly checking connection summaries and comparing against baseline metrics. Sudden changes in connection counts or new device types may indicate security events requiring investigation.

Best Practices

  • Implement Caching: Connection summary data is computationally intensive to generate. Cache responses for at least 15-30 minutes to reduce server load and improve response times.

  • Use Appropriate Time Ranges: Start with shorter time ranges (1d, 7d) for operational monitoring and use longer ranges (30d, 90d) for trend analysis and reporting to balance data completeness with performance.

  • Pagination for Large Datasets: When monitoring large environments, use the limit and offset parameters to paginate through results efficiently. Consider limiting initial requests to 100-200 results.

  • Filter Strategically: Use the available filters (device_type, app_category, status) to reduce response size and focus on relevant data for your specific use case.

  • Monitor Rate Limits: This endpoint processes significant amounts of data. Implement exponential backoff in your applications and respect rate limiting to ensure consistent access.

  • Error Handling: Implement robust error handling for timeouts and server errors, as summary generation may occasionally take longer for large datasets or during high system load.

  • Trend Analysis: Store historical summary data locally to build longer-term trend analysis and compare performance across different time periods.

Back to top