get-usage.md

Get account usage API

You can programmatically get your account usage information using this API.

{% hint style="info" %} Please note that the response of this API is cached internally and refreshes every 6 hours. {% endhint %}

{% swagger baseUrl="https://api.imagekit.io" path="/v1/accounts/usage" method="get" summary="Get account usage information" %} {% swagger-description %} Get the account usage information between two dates. Note that the API response includes data from the start date while excluding data from the end date. In other words, the data covers the period starting from the specified start date up to, but not including, the end date. {% endswagger-description %}

{% swagger-parameter in="header" name="Authorization" required="true" %} base64 encoding of your_private_api_key:

Note the colon in the end. {% endswagger-parameter %}

{% swagger-parameter in="query" name="startDate" %} Specify a startDate in YYYY-MM-DD format. It should be before the endDate. The difference between startDate and endDate should be less than 90 days. {% endswagger-parameter %}

{% swagger-parameter in="query" name="endDate" %} Specify a endDate in YYYY-MM-DD format. It should be after the startDate. The difference between startDate and endDate should be less than 90 days. {% endswagger-parameter %}

{% swagger-response status="200" description="In the response, you will get different usage metrics" %}

{
    "bandwidthBytes": 21991583578,
    "mediaLibraryStorageBytes": 1878758298,
    "videoProcessingUnitsCount": 0,
    "extensionUnitsCount": 0,
    "originalCacheStorageBytes": 0
}

{% endswagger-response %} {% endswagger %}

Examples

Get usage between 2023-04-01 and 2023-03-01.

{% tabs %} {% tab title="cURL" %}

curl -X GET "https://api.imagekit.io/v1/accounts/usage?startDate=2023-04-01&endDate=2023-03-01" \
-H 'Content-Type: application/json' \
-u your_private_key:

{% endtab %}

{% endtabs %}