Skip to content

Usage Statistics

Retrieve usage statistics and quota information for your account.

GET /api/v1/{customer_uuid}/usage/

Query Parameters

Parameter Type Default Description
period string monthly Period type: monthly or daily
limit integer 12 Number of periods to return

Example Request

curl https://geocoder.amigocloud.com/api/v1/{uuid}/usage/?period=monthly&limit=3 \
  -H "X-API-Key: your-key"

Example Response

{
  "customer": {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Example Corp"
  },
  "period": "monthly",
  "quota": {
    "geocode": { "used": 450, "limit": 1000 },
    "reverse": { "used": 120, "limit": 1000 },
    "autocomplete": { "used": 800, "limit": 5000 },
    "period": "daily",
    "reset_at": "2026-03-14T00:00:00Z"
  },
  "usage": [
    {
      "period_start": "2026-03-01T00:00:00Z",
      "period_end": "2026-03-31T23:59:59Z",
      "endpoints": {
        "geocode": 1250,
        "reverse": 340,
        "autocomplete": 2100
      },
      "total_count": 9290,
      "success_count": 9200,
      "failure_count": 90,
      "avg_response_time_ms": 145.32,
      "max_response_time_ms": 890
    }
  ]
}