Skip to Content
ReferenceAPI referenceGeo Locations

List the stored locations

GET
/api/v1/geo-locations

Returns every location GeoMetrikks has resolved, paged with currentPage and pageSize. It takes no time range or filters. Pass an item's id to /api/v1/geo-locations/{location_id}/top-ips.

Authorization

cookiesession<token>

Session cookie authentication.

Query Parameters

currentPage?integer

The page to return, counted from 1. Defaults to 1.

Range1 <= value
Default1
pageSize?integer

Rows per page, from 1 to 500. Defaults to 10.

Range1 <= value <= 500
Default10

Response Body

Request fulfilled, document follows

application/json
  1. response

One page of results. total counts the matches on every page, limit is the page size and offset is how many matches come before this page.

items?array<>
limit?integer

Maximal number of items to send.

offset?integer

Offset from the beginning of the query.

total?integer

Total number of items.

Example Request
curl -X GET 'https://geometrikks.example.com/api/v1/geo-locations'
Example Response
{  "items": [    {      "city": "string",      "countryCode": "string",      "countryName": "string",      "createdAt": "2019-08-24T14:15:22Z",      "geographicPoint": "string",      "geohash": "string",      "id": 0,      "lastHit": "2019-08-24T14:15:22Z",      "latitude": 0,      "longitude": 0,      "postalCode": "string",      "state": "string",      "stateCode": "string",      "timezone": "string",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "limit": 0,  "offset": 0,  "total": 0}