Get usage history | Alephant API Documentation

curl -G https:https://localhost:8080/api/v1/analytics/usage-history \
     -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampletoken1234567890" \
     -H "X-Workspace-Id: a3f1c9d2-4b7e-4f8a-9c3d-2b1e5f7a9d6c" \
     -H "Content-Type: application/json" \
     -d months=6

{
  "data": [
    {
      "month": "2024-05",
      "usageCount": 1250,
      "changePercent": 5.2,
      "changeReason": "computed"
    },
    {
      "month": "2024-04",
      "usageCount": 1187,
      "changePercent": -3.1,
      "changeReason": "computed"
    },
    {
      "month": "2024-03",
      "usageCount": 1225,
      "changeReason": "no_prev_window"
    },
    {
      "month": "2024-02",
      "usageCount": 0,
      "changeReason": "baseline_zero"
    },
    {
      "month": "2024-01",
      "usageCount": 0
    },
    {
      "month": "2023-12",
      "usageCount": 0
    }
  ]
}

Get usage history by month for the past N months. Owner, admin, viewer.

Headers

AuthorizationstringRequired

Bearer {access_token}

X-Workspace-IdstringRequired

Workspace UUID

Query parameters

monthsintegerOptionalDefaults to 12

Number of months (1-24)

Response

Wrapped as {“data”: UsageHistoryResponse}. Each month: changePercent is JSON null when not computable; changeReason optional (computed|baseline_zero|no_prev_window).

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error