Skip to main content

Hostspot Locations

The Hotspot Locations API provides access to geographical location data for network hotspots within your organization. This endpoint enables you to retrieve and filter hotspot location information, making it essential for network management, geographical analysis, and location-based services.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Overview

The Hotspot Locations API allows you to access comprehensive location data for network hotspots deployed across your infrastructure. This API is designed for network administrators, facility managers, and developers who need to:

  • Monitor Network Coverage: Track where hotspots are deployed geographically to identify coverage gaps or overlaps
  • Asset Management: Maintain an inventory of hotspot locations with coordinate data for mapping and visualization
  • Location-based Analytics: Analyze network usage patterns by geographical location
  • Integration with Mapping Services: Export location data to third-party mapping or GIS applications

The API provides flexible filtering options to help you find specific locations based on modification dates and coordinate availability. All location data includes metadata about when records were last updated, making it easy to synchronize with external systems or track changes over time.

This endpoint supports pagination for efficient handling of large datasets and includes filtering capabilities to retrieve only the locations relevant to your specific use case.

Endpoints

GET /hostspot_locations/

Description: Retrieves a paginated list of hotspot locations with optional filtering capabilities. This endpoint is essential for obtaining geographical data about your network hotspots, including their coordinates and metadata. Use this endpoint when you need to display hotspots on maps, analyze coverage areas, or synchronize location data with external systems.

Use Cases:

  • Generate network coverage maps showing all active hotspot locations
  • Export location data for GIS analysis and network planning
  • Synchronize hotspot coordinates with facility management systems
  • Filter locations that have been updated since a specific date for incremental updates

Full URL Example:

https://gate.zequenze.com/api/v1/hostspot_locations/?have_coordinates=true&limit=50&offset=0

Parameters:

Parameter Type In Required Description
last_change__gte string query No Filter locations modified on or after the specified date/time. Accepts ISO format: 2000-01-01, 2000-01-01 00:01:00, or 2000-01-01 00:01:00+00:00
limit integer query No Number of results to return per page. Default is typically 20, maximum varies by system configuration
offset integer query No The initial index from which to return results for pagination. Use with limit for page-by-page navigation
have_coordinates boolean query No When set to true, returns only locations that have latitude/longitude coordinates defined

cURL Example:

curl -X GET "https://gate.zequenze.com/api/v1/hostspot_locations/?have_coordinates=true&limit=25&last_change__gte=2024-01-01" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "count": 156,
  "next": "https://gate.zequenze.com/api/v1/hostspot_locations/?have_coordinates=true&limit=25&offset=25",
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "Main Building Lobby",
      "description": "Primary entrance Wi-Fi hotspot",
      "latitude": 40.7589,
      "longitude": -73.9851,
      "address": "123 Business Plaza, New York, NY 10001",
      "building": "Main Building",
      "floor": "Ground Floor",
      "status": "active",
      "coverage_radius": 50,
      "last_change": "2024-01-15T14:30:22.123456Z",
      "created_at": "2023-06-12T09:15:00Z",
      "organization_id": 42,
      "device_count": 3
    },
    {
      "id": 2,
      "name": "Conference Room A",
      "description": "Meeting room wireless access point",
      "latitude": 40.7591,
      "longitude": -73.9849,
      "address": "123 Business Plaza, New York, NY 10001",
      "building": "Main Building",
      "floor": "2nd Floor",
      "status": "active",
      "coverage_radius": 30,
      "last_change": "2024-01-10T11:22:15.789012Z",
      "created_at": "2023-06-12T09:20:00Z",
      "organization_id": 42,
      "device_count": 1
    },
    {
      "id": 3,
      "name": "Warehouse Loading Dock",
      "description": "Outdoor coverage for loading area",
      "latitude": 40.7585,
      "longitude": -73.9855,
      "address": "125 Business Plaza, New York, NY 10001",
      "building": "Warehouse",
      "floor": null,
      "status": "maintenance",
      "coverage_radius": 75,
      "last_change": "2024-01-08T16:45:33.456789Z",
      "created_at": "2023-08-22T13:10:00Z",
      "organization_id": 42,
      "device_count": 2
    }
  ]
}

Response Codes:

Status Description
200 Success - Returns paginated list of hotspot locations
400 Bad Request - Invalid query parameters (e.g., malformed date format)
401 Unauthorized - Invalid or missing authentication token
403 Forbidden - Insufficient permissions to access location data
429 Too Many Requests - Rate limit exceeded

Common Use Cases

Use Case 1: Network Coverage Mapping

Retrieve all hotspot locations with coordinates to display on an interactive map for network planning and coverage analysis.

GET /hostspot_locations/?have_coordinates=true&limit=100

Use Case 2: Incremental Data Synchronization

Sync only locations that have been modified since your last update to maintain current data in external systems.

GET /hostspot_locations/?last_change__gte=2024-01-15T00:00:00Z

Use Case 3: Facility Management Integration

Export location data for specific buildings or areas to integrate with facility management and asset tracking systems.

GET /hostspot_locations/?have_coordinates=true&limit=50&offset=0

Use Case 4: Maintenance Planning

Filter locations by modification date to identify hotspots that may need attention or have recent configuration changes.

GET /hostspot_locations/?last_change__gte=2024-01-01&limit=25

Best Practices

  • Use Pagination Efficiently: Start with reasonable page sizes (25-50 records) and adjust based on your application's performance requirements
  • Filter by Coordinates: When displaying locations on maps, always use have_coordinates=true to avoid processing locations without geographical data
  • Implement Incremental Updates: Use the last_change__gte parameter to fetch only modified records, reducing bandwidth and processing time
  • Handle Timezone Considerations: When using date filters, ensure your timestamps include timezone information for accurate filtering
  • Cache Appropriately: Location data typically changes infrequently, making it suitable for caching with reasonable TTL values
  • Error Handling: Implement retry logic for temporary failures and validate date format parameters before making requests
  • Rate Limiting: Respect API rate limits by implementing appropriate delays between requests when processing large datasets
  • Coordinate Validation: Verify latitude/longitude values are within valid ranges (-90 to 90 for latitude, -180 to 180 for longitude) before using in mapping applications
Back to top