Skip to content

Usage Dashboard

Visual dashboard showing API usage statistics for a customer.

Endpoint

GET /api/v1/{customer_uuid}/dashboard/

Authentication

The dashboard accepts the API key in two ways:

  1. Header (standard): X-API-Key: your-api-key
  2. Query parameter (browser-friendly): ?api_key=your-api-key

Query Parameters

Parameter Type Default Description
period string monthly Time period: weekly, monthly, or yearly
api_key string API key (alternative to header)

Usage

Open in a browser:

https://geocoder.amigocloud.com/api/v1/{uuid}/dashboard/?api_key=pk_live_xxxxx

Dashboard Contents

  • Summary cards: Total calls, success rate, average response time
  • Bar chart: Calls over time broken down by endpoint (geocode, reverse, autocomplete)
  • Doughnut chart: Endpoint distribution
  • Data table: Detailed numbers per period

Periods

Period Shows
Weekly Current week + last 4 weeks
Monthly Current month + last 3 months
Yearly All months in the current year