Skip to content
Last updated

Retrieve usage heatmap data for visualizing patterns across different time periods and days of the week.

GEThttps://api.aitronos.com/v1/analytics/usage/heatmap/{org_id}

Path Parameters

org_id string required

The organization ID.

Query Parameters

days integer

Number of days to analyze. Default: 30. Range: 7-90.

metric string optional

Metric type to analyze: neurons, synapses, or omit for combined metrics. Default: combined (null).

Returns

Returns heatmap data showing usage intensity across time periods.

Bash
curl "https://api.aitronos.com/v1/analytics/usage/heatmap/org_abc123?days=30" \
  -H "X-API-Key: $FREDDY_API_KEY"

Response:

200 OK
{
  "organization_id": "org_abc123",
  "metric": null,
  "heatmap_data": {
    "monday": {"00": 0, "01": 0, "09": 450, "10": 820, "11": 910},
    "tuesday": {"00": 0, "09": 380, "10": 750, "14": 620},
    "wednesday": {"10": 900, "11": 1100, "15": 400},
    "saturday": {"00": 0, "12": 150},
    "sunday": {"00": 0}
  },
  "peak_hours": [
    {"day": "wednesday", "hour": 11, "value": 1100},
    {"day": "monday", "hour": 11, "value": 910}
  ],
  "patterns": {
    "peak_day": "wednesday",
    "peak_hour": 11,
    "low_activity_days": ["saturday", "sunday"]
  }
}