Skip to main content

Hostspot Locations

Endpoints Summary

Method Path Swagger GET /hostspot_locations/ Swagger ↗

The HostspotHotspot Locations API provides access to physical location data andfor geographichotspot informationdevices forwithin your hotspots.organization. Use thisThis endpoint allows you to retrieve locationdetailed information about locations including geographical coordinates, addresses, and organizational details, filtermaking byit geographicessential criteria,for location-based analytics, mapping applications, and managedevice locationmanagement metadata for network infrastructure planning and reporting.systems.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Overview

The HostspotHotspot Locations API enables you to manage and queryretrieve location data for hotspot devices across your organization's network hotspots.infrastructure. This API is essentialparticularly foruseful organizations that need to track the geographic distribution of their network infrastructure, generate location-based reports, and maintain accurate records of hotspot deployments.

Key capabilities include:for:

  • LocationNetwork Management: Retrieve comprehensive location data including addresses, coordinates,Track and organizationalorganize detailsphysical locations where hotspot devices are deployed
  • Geographic FilteringAnalytics: FilterAnalyze network usage patterns across different locations basedand on coordinate availability for mapping applicationsregions
  • ChangeMapping TrackingApplications: MonitorDisplay locationhotspot updateslocations usingon timestamp-basedinteractive filteringmaps for synchronizationadministrative dashboards
  • PaginationLocation-Based SupportServices: HandleProvide largelocation-aware datasetsfeatures efficientlyand withservices built-into paginationend controlsusers
Compliance & Reporting: Generate location-based reports for regulatory compliance or business intelligence

The API followssupports RESTfulfiltering principlesby coordinates, change tracking for synchronization purposes, and returnscomprehensive paginatedlocation resultsmetadata forincluding optimaladdresses, performance.postal Locationcodes, and geographic coordinates. All location data is scoped to your organization and includes both basic information (name, description, status)active and detailedinactive geographic data (coordinates, addresses, regional information) that can be usedlocations for mapping,complete analytics,lifecycle and infrastructure planning.management.

Endpoints

GET /hostspot_locations/

Description: Retrieves a paginated list of hostspotall hotspot locations withwithin comprehensiveyour filtering options.organization. This endpoint is the primary method for accessing location data and supports various filtering criteriaoptions to help you find specific locations based on coordinates availability, recent changes, or subsetsother ofcriteria. yourUse this endpoint to populate location inventory.dropdowns, generate maps, or synchronize location data with external systems.

Use Cases:

  • GenerateBuilding reportsa map interface showing all active hotspot locations acrosswith your organizationcoordinates
  • SyncSynchronizing location data with external mapping or analytics systems using timestampthe filteringlast_change filter
  • RetrieveGenerating onlyreports of active vs inactive locations
withPopulating GPSlocation coordinatesselection interfaces for mappingdevice applications Build dashboards showing geographic distribution of network infrastructuremanagement

Full URL Example:

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

Parameters:

Parameter Type In Required Description
last_change__gte string query No Filter locations modified onsince ora after thisspecific date/time. AcceptsUse 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 pagination limit applies)
offset integer query No StartingThe starting index for results (used for pagination)
have_coordinates boolean query No When true, returns only locations with both latitude and longitude values set

cURL Example:

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

Example Response:

{
  "count": 247,156,
  "next": "https://gate.zequenze.com/api/v1/hostspot_locations/?have_coordinates=true&limit=2510&offset=25"10",
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "Downtown Coffee Shop - Main Street"Shop",
      "short_name": "downtown-coffee-main"coffee",
      "is_active": true,
      "description": "PrimaryHigh-traffic location serving thein downtown business district with high-capacity WiFi access"district",
      "organization_id": "org_12345",
      "thumbnail": "https://gate.zequenze.com/media/locations/downtown-coffee-thumb.thumbnails/location_1.jpg",
      "address": "123 Main Street",
      "reference": "Building A, Ground Floor",
      "city": "San Francisco",
      "postal_code": "94102"94105",
      "state": "California",
      "region": "Pacific"Bay Area",
      "country_code": "US",
      "latitude": "37.7749",
      "longitude": "-122.4194",
      "created": "2024-01-15T09:15T10:30:00Z",
      "last_change": "2024-03-10T14:22:15Z"00Z"
    },
    {
      "id": 2,
      "name": "UniversityAirport LibraryTerminal - Tech Campus"B",
      "short_name": "university-library-tech"airport-terminal-b",
      "is_active": true,
      "description": "EducationalInternational hotspotdepartures providingterminal internet access for students and faculty"hotspot",
      "organization_id": "org_12345",
      "thumbnail": "https://gate.zequenze.com/media/locations/university-lib-thumb.jpg",null,
      "address": "456San UniversityFrancisco Ave"International Airport",
      "reference": "LibraryTerminal Building,B, 2ndGate Floor"Area",
      "city": "PaloSan Alto"Francisco",
      "postal_code": "94301"94128",
      "state": "California",
      "region": "Pacific"Bay Area",
      "country_code": "US",
      "latitude": "37.4419"6213",
      "longitude": "-122.1430"3790",
      "created": "2024-01-20T11:02-01T08:15:30Z"00Z",
      "last_change": "2024-02-28T16:03-05T16:45:22Z"00Z"
    }
  ]
}

Response Codes:

Status Description
200 Success - Returns the paginated list of hotspot locations
401 Unauthorized - Invalid or missing Bearer token
400403 BadForbidden Request- Token valid but lacks permission to access locations
422 Unprocessable Entity - Invalid parameter valuesformat (e.g., malformed date) 429 Too Many Requests - Rate limit exceeded

Common Use Cases

Use Case 1: Building a Location Map Dashboard

Retrieve all locations with GPS coordinates to display hotspots on an interactive map for network monitoring dashboards.administrators.

https://gate.zequenze.com/api/v1/hostspot_locations/?have_coordinates=true&is_active=true

Use Case 2: SynchronizingSyncing Location Data

UseSynchronize location changes since your last update using the timestamp filteringfilter to sync only recently modified locations with external systems, reducingfor data transfer and processing time.consistency.

https://gate.zequenze.com/api/v1/hostspot_locations/?last_change__gte=2024-03-01T00:00:00Z

Use Case 3: Generating Location ReportsSelection Interface

Paginate through allLoad locations towith createpagination comprehensivefor reportsdevice showingassignment locationor distribution,configuration status, and organizational assignments.interfaces.

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

Use Case 4: Location-BasedGeographic Analytics

Filter andlocations retrieveby locationregion dataor coordinates to analyze geographic patterns, identifynetwork coverage gaps,and orusage plan new hotspot deployments.patterns.

https://gate.zequenze.com/api/v1/hostspot_locations/?country_code=UShave_coordinates=true&is_active=truelimit=100

Use Case 5: Inventory Management

Retrieve all locations (active and inactive) for comprehensive device deployment planning.

https://gate.zequenze.com/api/v1/hostspot_locations/?limit=50

Best Practices

  • Use Pagination EfficientlyEffectively: ImplementAlways properimplement pagination byfor followinglarge thedatasets. nextStart with reasonable page sizes (25-50 items) and previousadjust URLsbased inon responsesyour ratherapplication's thanperformance manuallyrequirements.

    calculating offsets

  • Filter by Coordinates: When building mapping applications, always use have_coordinates=true to avoid processing locations without geographic datadata.

  • Implement IncrementalChange SyncTracking: Use the last_change__gte parameter withfor storedefficient timestampssynchronization. toStore the timestamp of your last successful sync only modified locations, improving performance and reducinguse bandwidthit in subsequent requests.

  • Cache Location Data: Location information typically changes infrequently, making it suitableideal for cachingcaching. withConsider appropriateimplementing TTLa valuescache invalidation strategy based on the last_change field.

  • Handle Missing Data Gracefully: Not all locations may have complete address information or coordinates. Design your application to handle optional fields appropriately.

Monitor Rate Limits: Implement exponentialproper backofferror whenhandling receivingand 429retry responses,logic for API rate limits, especially when processing large datasetsnumbers of locations.

Validate CountryGeographic CodesData: UseWhen using latitude/longitude values, validate that they fall within expected ranges and handle edge cases for locations near poles or the providedinternational countrydate codeline.

enum values when filtering or processing location data to ensure consistency Monitor Active Status: Always consider the is_active field when displaying locations to end users or in operational dashboards
Back to top