Get credit usage analytics

GET

/credits/widgets

Returns credit usage for the requested analytics view (widgetType) and time range.

fromTimestamp and toTimestamp are optional. If omitted, the last 14 days are used.
The range cannot exceed 90 days.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

Responses

🟢200

application/json

Analytics for the requested view.

Bodyapplication/json

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://app.highperformr.ai/api/credits/widgets?widgetType=&fromTimestamp=&toTimestamp=&segmentId=' \
--header 'x-api-key: <api-key>'

Response Example

200 - SUMMARY

{
    "widgetType": "SUMMARY",
    "fromTimestamp": "2026-09-01T00:00:00.000Z",
    "toTimestamp": "2026-09-07T23:59:59.999Z",
    "data": {
        "creditsPurchased": 5000,
        "purchasedTxnCount": 1,
        "creditsConsumed": 320,
        "consumedTxnCount": 18,
        "recordsBilled": 44,
        "dailyTrend": [
            {
                "date": "2026-09-01",
                "creditsPurchased": 0,
                "purchasedTxnCount": 0,
                "creditsConsumed": 40,
                "consumedTxnCount": 4,
                "recordsBilled": 12
            }
        ]
    }
}

Modified at 2026-10-07 08:33:47

Get workspace credit balance

Filter templates