Skip to main content

Device App Connection Summary

Provides device and application connection summary analytics and reporting.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Endpoints

GET /device_app_connection_summary/

Retrieve comprehensive connection summary reports showing device-to-application connection statistics and analytics.

Parameters:

Parameter Type In Required Description
start_date string query No Start date for report period (YYYY-MM-DD format)
end_date string query No End date for report period (YYYY-MM-DD format)
device_id string query No Filter by specific device ID
app_id string query No Filter by specific application ID
limit integer query No Number of results to return per page (default: 20)
offset integer query No The initial index from which to return results (default: 0)

Example Request:

GET /api/v1/device_app_connection_summary/?start_date=2024-01-01&end_date=2024-01-31&limit=50

Example Response:

{
  "count": 125,
  "next": "https://gate.zequenze.com/api/v1/device_app_connection_summary/?limit=50&offset=50",
  "previous": null,
  "results": [
    {
      "device_id": "device_12345",
      "device_name": "Mobile Device Alpha",
      "app_id": "app_67890",
      "app_name": "Analytics Dashboard",
      "total_connections": 1847,
      "successful_connections": 1823,
      "failed_connections": 24,
      "success_rate": 98.7,
      "average_connection_duration": 1245.5,
      "last_connection": "2024-01-31T14:23:45Z",
      "first_connection": "2024-01-01T08:15:30Z",
      "connection_frequency": "high",
      "data_transferred_mb": 2847.3
    },
    {
      "device_id": "device_54321",
      "device_name": "IoT Sensor Beta",
      "app_id": "app_09876",
      "app_name": "Monitoring Service",
      "total_connections": 3456,
      "successful_connections": 3401,
      "failed_connections": 55,
      "success_rate": 98.4,
      "average_connection_duration": 45.2,
      "last_connection": "2024-01-31T23:59:12Z",
      "first_connection": "2024-01-01T00:01:15Z",
      "connection_frequency": "very_high",
      "data_transferred_mb": 156.8
    }
  ],
  "summary": {
    "total_devices": 85,
    "total_applications": 23,
    "overall_success_rate": 97.2,
    "total_data_transferred_gb": 45.6,
    "reporting_period": {
      "start": "2024-01-01",
      "end": "2024-01-31"
    }
  }
}
Status Description
200 Connection summary retrieved successfully
401 Unauthorized - Invalid or missing authentication token
403 Forbidden - Insufficient permissions to access connection data
422 Unprocessable Entity - Invalid date format or parameters

Best Practices

  • Date Filtering: Use start_date and end_date parameters to limit report scope and improve performance for large datasets
  • Pagination: Implement proper pagination handling for large result sets using limit and offset parameters
  • Caching: Connection summary data is updated every 15 minutes; consider caching responses appropriately
  • Rate Limiting: This endpoint has enhanced rate limits due to computational complexity - limit requests to avoid throttling
  • Error Handling: Monitor success_rate values to identify problematic device-app combinations requiring attention
  • Performance: For real-time monitoring, combine with other device status endpoints rather than polling this summary frequently
Back to top