Skip to main content

Device App Connection Summary

Endpoints Summary

Method Path Swagger GET /device_app_connection_summary/ Swagger ↗

The deviceDevice appApp connectionConnection summarySummary API provides insights into how mobile applicationsdevices connect to devicesapplications within your network.system. This endpoint delivers aggregated connection data, helping administrators monitor device connectivityusage patternspatterns, track application connectivity, and troubleshootgenerate connectionreports issues.for network optimization and troubleshooting.

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 category is designed for networksystem administrators and system integratorsdevelopers who need to monitor and analyze howdevice-to-application mobileconnectivity applicationspatterns. interact with IoT devices, sensors, or other connected hardware in their infrastructure.

This API provides aggregated data about how devices in your network connect to various applications, including connection statisticsfrequencies, thatsuccess helprates, youand understand:usage statistics.

Key Features:

  • Which Connection Analytics: Track how often devices areconnect activelyto communicatingspecific with mobile appsapplications
  • Connection Performance Monitoring: Monitor connection success rates and failureidentify patternsproblematic connections
  • Peak Usage Patterns: Understand peak usage times and connection duration metricstrends
  • Device availabilityNetwork andOptimization: responsivenessIdentify dataunderutilized or overloaded connections

Common scenariosIntegration includeScenarios:

monitoring
smartBuilding buildingadministrative systems,dashboards industrialthat IoTdisplay deployments,device connectivity health Creating automated alerts for connection failures or unusual patterns Generating reports for network capacity planning and optimization Monitoring device fleet managementperformance solutions,and application usage

The data returned by this API is typically aggregated over time periods and can be filtered by various parameters to focus on specific devices, applications, or anytime environment where mobile applications need to maintain reliable connections with physical devices. The summary data helps identify connectivity issues before they impact end users and provides valuable insights for capacity planning.ranges.

Endpoints

GET /device_app_connection_summary/

Description: Retrieves a comprehensive summary of device-to-application connections, including connection statisticscounts, betweensuccess mobile applicationsrates, and devicesusage in your network.statistics. This endpoint aggregatesprovides connectionaggregated data overthat specifiedhelps timeadministrators periods,understand providingconnectivity insights into connection success rates, failure patterns, device availability,patterns and usageidentify trends.potential issues or optimization opportunities.

Use Cases:

  • Generate daily/weekly/monthly connection reports for management
Monitor overalldevice systemfleet connectivity health and device connectivity status Generate reports on device utilization and connection patternsperformance Identify devices or applications with frequent connection issues requiring maintenance Analyze peakTrack usage periodspatterns to optimize network resources Create automated alerts for capacityconnection planninganomalies

Full URL Example:

https://gate.zequenze.com/api/v1/device_app_connection_summary/?time_range=24htime_period=7d&device_type=sensormobile&limit=50

Parameters:

Parameter Type In Required Description
time_rangetime_period string query No Time periodrange for summary data (1h, 24h,1d, 7d, 30d)30d, 90d). DefaultsDefault: to 24h7d
device_type string query No Filter by device type (sensor,mobile, gateway,desktop, controller,tablet, etc.)iot)
app_category string query No Filter by application category organization string query No Filter by organization ID or name status string query No Filter by connection status (active, inactive,failed, error)disconnected) limit integer query No Number of results perto pagereturn (default:max 50,100). max:Default: 200)20 offset integer query No Number of results to skip for paginationpagination. Default: 0

cURL Example:

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

Example Response:

{
  "count": 25,156,
  "next": "https://gate.zequenze.com/api/v1/device_app_connection_summary/?limit=1025&offset=10"25",
  "previous": null,
  "summary"summary_period": {
    "total_devices": 150,
    "active_connections": 142,
    "success_rate": 94.7,
    "average_response_time": 234,
    "time_range": "24h",
    "last_updated"start_date": "2024-01-15T14:30:01T00:00:00Z",
    "end_date": "2024-01-31T23:59:59Z",
    "period": "30d"
  },
  "results": [
    {
      "device_id": "dev_001"dev_12345",
      "device_name": "Temperature Sensor - Building A"iPhone-Marketing-001",
      "device_type": "sensor"mobile",
      "organization": "AcmeMarketing Corp"Department",
      "total_attempts"app_connections": 288,[
        {
          "app_id": "app_67890",
          "app_name": "Salesforce Mobile",
          "app_category": "CRM",
          "total_connections": 342,
          "successful_connections": 275,338,
          "failed_connections": 13,4,
          "success_rate": 95.5,98.8,
          "average_response_time"avg_connection_duration": 187,1847,
          "last_successful_connection"last_connection": "2024-01-15T14:25:00Z"31T14:22:15Z",
          "status"data_transferred_mb": 125.7
        },
        {
          "app_id": "active"app_54321",
          "connection_quality"app_name": "excellent"Slack",
          "app_category": "Communication",
          "total_connections": 891,
          "successful_connections": 889,
          "failed_connections": 2,
          "success_rate": 99.8,
          "avg_connection_duration": 3600,
          "last_connection": "2024-01-31T16:45:33Z",
          "data_transferred_mb": 89.3
        }
      ],
      "device_summary": {
        "total_connections": 1233,
        "overall_success_rate": 99.4,
        "total_data_transferred_mb": 215.0,
        "most_used_app": "Slack",
        "connection_trend": "stable"
      }
    },
    {
      "device_id": "dev_002"dev_67891",
      "device_name": "Smart Gateway - Floor 3"Desktop-IT-005",
      "device_type": "gateway"desktop",
      "organization": "AcmeIT Corp"Department",
      "total_attempts"app_connections": 432,[
        {
          "app_id": "app_11223",
          "app_name": "Azure DevOps",
          "app_category": "Development",
          "total_connections": 156,
          "successful_connections": 398,154,
          "failed_connections": 34,2,
          "success_rate": 92.1,98.7,
          "average_response_time"avg_connection_duration": 312,7200,
          "last_successful_connection"last_connection": "2024-01-15T14:28:31T17:30:00Z",
          "status"data_transferred_mb": "active",
      "connection_quality": "good"445.2
        }
      ],
      "device_summary": {
        "total_connections": 156,
        "overall_success_rate": 98.7,
        "total_data_transferred_mb": 445.2,
        "most_used_app": "Azure DevOps",
        "connection_trend": "increasing"
      }
    }
  ],
  "aggregate_stats": {
    "total_devices": 156,
    "total_applications": 24,
    "overall_success_rate": 97.6,
    "total_data_transferred_gb": 12.7,
    "top_performing_apps": [
      {
        "app_name": "Slack",
        "success_rate": 99.8
      },
      {
        "app_name": "Office 365",
        "success_rate": 99.2
      }
    ],
    "devices_with_issues": 8
  }
}

Response Codes:

Status Description
200 Success - Returns connection summary data
400
Bad Request - Invalid parameters (e.g., invalid time_period format) 401 Unauthorized - Invalid or missing APIBearer token 403 Forbidden - Insufficient permissions forto requestedaccess connection data 400429 BadToo RequestMany Requests - InvalidRate parameterslimit (e.g., unsupported time_range)exceeded 500 Internal Server Error - Server-sideServer error processing errorthe request

Common Use Cases

Use Case 1: SystemDaily Connection Health Dashboard

MonitorRetrieve connection summaries for the past 24 hours to display on an administrative dashboard, showing which devices and applications are experiencing connection issues and overall connectivitynetwork health acrossmetrics.

all devices in your network.

Use theCase summary2: endpointMonthly withPerformance defaultReports

parameters

Generate tocomprehensive getmonthly areports quickshowing overviewconnection oftrends, data usage patterns, and device performance metrics for management review and capacity planning.

Use Case 3: Proactive Issue Detection

Monitor connection success rates and identify any devices experiencingor applications with declining performance, enabling proactive troubleshooting before users experience significant issues.

Use Case 2:4: MaintenanceUsage PlanningPattern Analysis

Filter by device type and analyzeAnalyze connection qualitydata trendsacross over longerdifferent 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 duringunderstand peak usage periods totimes, optimize networkresource configurationallocation, and identify bandwidth bottlenecks.

Use Case 4: Organizational Reporting

Generate periodic reportsplan for differentinfrastructure organizations or departments by filtering results and analyzing connection patterns specific to their device deployments.scaling.

Use Case 5: TroubleshootingCompliance Supportand Audit Reporting

WhenGenerate usersdetailed reportconnection connectivity issues, quickly identify affected deviceslogs and theirusage recentstatistics connectionfor historycompliance toaudits, acceleratesecurity problem resolutionreviews, and determineorganizational ifpolicy issues are isolated or systemic.enforcement.

Best Practices

  • Pagination:Pagination Strategy: Use appropriatereasonable limit values (10-20-50) for real-timebetter dashboardsperformance. toThe ensureAPI fast response times. For bulk analysis, you can increase the limitsupports up to 200100 results per request.request, but smaller batches often provide better response times.

  • Time RangePeriod Selection: Choose appropriate time rangesperiods based on your use casecase. -Use useshorter 1hperiods or(1d, 24h7d) for operationalreal-time monitoring,monitoring 7dand longer periods (30d, 90d) for trend analysis,analysis.

Caching Recommendations: Connection summary data is typically updated every 15 minutes. Implement client-side caching with appropriate TTL to reduce API calls and 30dimprove application performance.

Error Handling: Always check the success_rate and failed_connections fields to identify problematic devices or applications. Implement alerts for capacitysuccess planningrates below acceptable thresholds (typically < 95%).

Rate Limiting: The API is rate-limited to prevent abuse. Implement exponential backoff for 429 responses and reporting.consider batching requests during off-peak hours for large data pulls.

Filtering Strategy:Optimization: ApplyUse device_type and organizationspecific filters (device_type, organization, app_category) to reduce response payload size and improve query performance when you only need specific subsets oftargeted data.

Caching:Data Interpretation: ConnectionPay summary data is typically updated every 5-15 minutes. Implement client-side cachingattention to avoid unnecessary API calls and respect rate limits.

Error Handling: Always check the success_rateconnection_trend andfield connection_qualityin fieldsdevice summaries to programmatically identify devices that may need attention.attention Setor upoptimization, alertsand use aggregate_stats for devicesoverall withsystem successhealth rates below 90%.

Rate Limiting: This endpoint supports up to 100 requests per minute per API token. For high-frequency monitoring, consider using webhooks or WebSocket connections for real-time updates instead of polling.monitoring.

Back to top