Skip to main content

Device App Connection Summary

ThisThe endpointdevice providesapp connection summary reportsAPI forprovides insights into how mobile applications connect to devices and applications within your system.network. ItThis endpoint delivers aggregated statisticsconnection and overview data about device-to-application connections,data, helping administrators monitor device connectivity patterns, identify issues,patterns and analyzetroubleshoot usageconnection trends across their infrastructure.issues.

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 providescategory comprehensiveis reporting capabilitiesdesigned for monitoringnetwork administrators and analyzingsystem theintegrators connectivitywho betweenneed devicesto monitor and analyze how mobile applications interact with IoT devices, sensors, or other connected hardware in your networktheir infrastructure. This endpoint aggregates connection data to deliver high-level insights into your system's connectivity health.

This API isprovides essentialaggregated forconnection networkstatistics administrators,that IThelp managers,you and system operators who need to:understand:

  • MonitorWhich overalldevices connectivityare statusactively acrosscommunicating theirwith devicemobile fleetapps
  • IdentifyConnection success rates and failure patterns
Peak usage times and connection patternsduration metrics Device availability and usageresponsiveness trends Track application adoption and device utilization Generate reports for capacity planning and troubleshooting Analyze connection performance metrics over timedata

Common scenarios include monitoring smart building systems, industrial IoT deployments, fleet management solutions, or any environment where mobile applications need to maintain reliable connections with physical devices. 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 potentialidentify connectivity issues thatbefore maythey requireimpact attention.end users and provides valuable insights for capacity planning.


Endpoints

GET /device_app_connection_summary/

Description: Retrieves a comprehensive summary report of device-to-applicationconnection connectionsstatistics acrossbetween mobile applications and devices in your infrastructure.network. This endpoint aggregates connection data toover providespecified time periods, providing insights into connectivity patterns,connection success rates, andfailure overallpatterns, systemdevice health. Use this endpoint to generate dashboards, monitor network performance,availability, and identifyusage devices or applications that may require attention.trends.

Use Cases:

  • Generate executive dashboards showingMonitor overall system health and device connectivity healthstatus
  • MonitorGenerate reports on device utilization and connection successpatterns
rates and identify problematicIdentify devices orwith applicationsfrequent connection issues requiring maintenance Analyze peak usage patternsperiods to informfor 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=7d24h&status=activedevice_type=sensor

Parameters:

Parameter Type In Required Description
time_range string query No Time period for the summary data (1d,1h, 24h, 7d, 30d, 90d)30d). Defaults to 7d24h
device_type string query No Filter by device type (sensor, gateway, controller, etc.) organization string query No Filter by organization ID or name 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 IDerror) limit integer query No Number of results to return per page (default: 100,50, max: 1000)200) 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=30d24h&status=active"limit=10" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "count": 1,25,
  "next": null,"https://gate.zequenze.com/api/v1/device_app_connection_summary/?limit=10&offset=10",
  "previous": null,
  "summary_period": {
    "start_date": "2024-01-01T00:00:00Z",
    "end_date": "2024-01-31T23:59:59Z",
    "time_range": "30d"
  },
  "overall_metrics"summary": {
    "total_devices": 1247,
    "active_devices": 1156,
    "total_applications": 89,150,
    "active_connections": 12489,142,
    "failed_connections"success_rate": 94.7,
    "average_response_time": 234,
    "success_rate"time_range": 98.1,"24h",
    "average_connections_per_device"last_updated": 10.8"2024-01-15T14:30:00Z"
  },
  "results": [
    {
      "connection_id"device_id": "conn_4f8b2a1c"dev_001",
      "device_info": {
        "device_id": 12456,
      "device_name": "LAPTOP-SALES-001"Temperature Sensor - Building A",
      "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"
      }sensor",
      "organization": {"Acme Corp",
      "id"total_attempts": 101,288,
      "name"successful_connections": 275,
      "failed_connections": 13,
      "success_rate": 95.5,
      "average_response_time": 187,
      "last_successful_connection": "Acme Corporation",
        "department": "Sales"
      }2024-01-15T14:25:00Z",
      "status": "active",
      "health_score"connection_quality": 95.2"excellent"
    }
  ],
  "aggregated_insights":
    {
      "top_applications": [
      {
        "app_name"device_id": "Customer CRM"dev_002", 
      "connection_count"device_name": 2847,"Smart "unique_devices":Gateway 234- }Floor ]3",
      "device_type_breakdown"device_type": {"gateway",
      "desktop"organization": 45.2,"Acme Corp",
      "mobile"total_attempts": 32.432,
      "successful_connections": 398,
      "failed_connections": 34,
      "success_rate": 92.1,
      "tablet"average_response_time": 15.7,312,
      "iot": 7.0
    },
    "connection_trends": {
      "daily_average": 402.5,
      "peak_day"last_successful_connection": "2024-01-15"15T14:28:00Z",
      "peak_connections"status": 567"active",
      "connection_quality": "good"
    }
  }]
}

Response Codes:

Status Description
200 Success - Returns connection summary data
400
Bad Request - Invalid parameters or time range 401 Unauthorized - Invalid or missing authenticationAPI token 403 Forbidden - Insufficient permissions tofor access connectionrequested data 429400 TooBad Many RequestsRequest - RateInvalid limitparameters exceeded(e.g., unsupported time_range) 500 Internal Server Error - Server-side processing error

Common Use Cases

Use Case 1: DailySystem OperationsHealth Dashboard

Generate a real-time dashboard for IT operations teams to monitorMonitor overall systemconnectivity health.health across all devices in your network. Use the summary endpoint with time_range=1ddefault and status=allparameters to get currenta dayquick statistics,overview of connection success rates,rates and identify any devices experiencing connectivity issues.

Use Case 2: MonthlyMaintenance Performance ReportsPlanning

Create comprehensive monthly reports for managementFilter by calling the endpoint with time_range=30d. The aggregated insights provide executive-level summaries of application usage, device adoption,type and connectivityanalyze connection quality trends acrossover thelonger organization.time periods (7d, 30d) to identify devices that may need preventive maintenance before they fail completely.

Use Case 3: Performance Optimization

Track average response times and connection success rates during peak usage periods to optimize network configuration and identify bandwidth bottlenecks.

Use Case 4: Organizational Reporting

Generate periodic reports for different organizations or departments by filtering results and analyzing connection patterns specific to their device deployments.

Use Case 5: Troubleshooting Connection IssuesSupport

When users report connectivity problems, filter by specific device_type or app_category with status=failed toissues, quickly identify patternsaffected indevices and their recent connection failureshistory to accelerate problem resolution and prioritizedetermine remediationif efforts.

issues

Useare 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 countsisolated or new device types may indicate security events requiring investigation.systemic.


Best Practices

  • ImplementPagination: Use appropriate limit values (10-50) for real-time dashboards to ensure fast response times. For bulk analysis, you can increase the limit up to 200 results per request.

Time Range Selection: Choose time ranges based on your use case - use 1h or 24h for operational monitoring, 7d for trend analysis, and 30d for capacity planning and reporting.

Filtering Strategy: Apply device_type and organization filters to reduce response payload size and improve query performance when you only need specific subsets of data.

Caching: Connection summary data is computationallytypically intensiveupdated every 5-15 minutes. Implement client-side caching to generate.avoid Cacheunnecessary responsesAPI 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 applicationscalls and respect rate limiting to ensure consistent access.limits.

Error Handling: ImplementAlways robustcheck errorthe handlingsuccess_rate and connection_quality fields to programmatically identify devices that need attention. Set up alerts for timeoutsdevices andwith serversuccess errors,rates asbelow summary generation may occasionally take longer for large datasets or during high system load.90%.

TrendRate Analysis:Limiting: StoreThis historicalendpoint summarysupports data locallyup to build100 longer-termrequests trendper analysisminute andper compareAPI performancetoken. acrossFor differenthigh-frequency monitoring, consider using webhooks or WebSocket connections for real-time periods.updates instead of polling.