Skip to main content

HotspotsResponseWrapper

successboolean
data object
resolutioninteger
daysinteger
countinteger
cells object[]
  • Array [
  • h3_indexstring

    H3 cell index in hex format

    resolutioninteger
    center object
    latnumber<double>
    Example: 5.6041
    lngnumber<double>
    Example: -0.1953
    request_countinteger<int64>
    first_seenstring

    ISO timestamp of first request in this cell

    last_seenstring

    ISO timestamp of most recent request

  • ]
  • meta object
    request_idstring<uuid>

    Unique request identifier

    Example: c86825f0-d8ca-4ae1-8226-514cc48e05c0
    cachedboolean

    Whether the response was served from cache

    Example: false
    latencystring

    Server-side processing time

    Example: 1.802457582s
    boundary_distance_mnumber<double>nullable

    Reverse-geocode responses only. Distance in metres from the queried coordinate to the nearest edge of the resolved GhanaPostGPS grid cell. Omitted when the upstream response carried no cell bounds.

    Example: 1.42
    near_grid_boundaryboolean

    Reverse-geocode responses only. True when boundary_distance_m is small enough that an ordinary GPS fix's jitter could plausibly have resolved to the neighbouring cell's code instead — the documented cause of the same property getting different GhanaPostGPS codes depending on where you stand.

    Example: false
    HotspotsResponseWrapper
    {
    "success": true,
    "data": {
    "resolution": 0,
    "days": 0,
    "count": 0,
    "cells": [
    {
    "h3_index": "string",
    "resolution": 0,
    "center": {
    "lat": 5.6041,
    "lng": -0.1953
    },
    "request_count": 0,
    "first_seen": "string",
    "last_seen": "string"
    }
    ]
    },
    "meta": {
    "request_id": "c86825f0-d8ca-4ae1-8226-514cc48e05c0",
    "cached": false,
    "latency": "1.802457582s",
    "boundary_distance_m": 1.42,
    "near_grid_boundary": false
    }
    }