Get monthly usage

GET 
https://api.apify.com/v2/users/me/usage/monthly

Returns a complete summary of your usage for the current usage cycle, an overall sum, as well as a daily breakdown of usage. It is the same information you will see on your account's Billing page. The information includes your use of storage, data transfer, and request queue usage.

Using the date parameter will show your usage in the usage cycle that includes that date.

Request

Query Parameters

date string

Date in the YYYY-MM-DD format.

Responses

200

Response Headers

application/json

Schema

Schema

data objectrequired
usageCycle objectrequired
startAtstringrequired
Example: 2022-10-02T00:00:00.000Z
endAtstringrequired
Example: 2022-11-01T23:59:59.999Z
monthlyServiceUsage objectrequired
USAGE_ITEM objectrequired
quantitynumberrequired
Example: 2.784475
baseAmountUsdnumberrequired
Example: 0.69611875
baseUnitPriceUsdnumberrequired
Example: 0.25
amountAfterVolumeDiscountUsdnumberrequired
Example: 0.69611875
priceTiers object[]required
Array [
quantityAbovenumberrequired
Example: 0
discountPercentnumberrequired
Example: 100
tierQuantitynumberrequired
Example: 0.39
unitPriceUsdnumberrequired
Example: 0
priceUsdnumberrequired
Example: 0
]
dailyServiceUsages object[]required
Array [
datestringrequired
Example: 2022-10-02T00:00:00.000Z
serviceUsage objectrequired
SERVICE_USAGE_ITEM objectrequired
quantitynumberrequired
Example: 2.784475
baseAmountUsdnumberrequired
Example: 0.69611875
baseUnitPriceUsdnumberrequired
Example: 0.25
amountAfterVolumeDiscountUsdnumberrequired
Example: 0.69611875
priceTiers object[]required
Array [
quantityAbovenumberrequired
Example: 0
discountPercentnumberrequired
Example: 100
tierQuantitynumberrequired
Example: 0.39
unitPriceUsdnumberrequired
Example: 0
priceUsdnumberrequired
Example: 0
]
totalUsageCreditsUsdnumberrequired
Example: 0.0474385791970591
]
totalUsageCreditsUsdBeforeVolumeDiscountnumberrequired
Example: 0.786143673840067
totalUsageCreditsUsdAfterVolumeDiscountnumberrequired
Example: 0.786143673840067

Example (auto)

{
  "data": {
    "usageCycle": {
      "startAt": "2022-10-02T00:00:00.000Z",
      "endAt": "2022-11-01T23:59:59.999Z"
    },
    "monthlyServiceUsage": {
      "USAGE_ITEM": {
        "quantity": 2.784475,
        "baseAmountUsd": 0.69611875,
        "baseUnitPriceUsd": 0.25,
        "amountAfterVolumeDiscountUsd": 0.69611875,
        "priceTiers": [
          {
            "quantityAbove": 0,
            "discountPercent": 100,
            "tierQuantity": 0.39,
            "unitPriceUsd": 0,
            "priceUsd": 0
          }
        ]
      }
    },
    "dailyServiceUsages": [
      {
        "date": "2022-10-02T00:00:00.000Z",
        "serviceUsage": {
          "SERVICE_USAGE_ITEM": {
            "quantity": 60,
            "baseAmountUsd": 0.00030000000000000003
          }
        },
        "totalUsageCreditsUsd": 0.0474385791970591
      }
    ],
    "totalUsageCreditsUsdBeforeVolumeDiscount": 0.786143673840067,
    "totalUsageCreditsUsdAfterVolumeDiscount": 0.786143673840067
  }
}

Authorization: http

name: httpBearertype: httpscheme: bearerdescription: API authentication token.

• CLI
• JavaScript
• Python
• PHP
• Java
• C
• C#
• Go
• Rust
• Node.js
• Ruby
• PowerShell
• Dart
• Objective-C
• OCaml
• R
• Swift
• Kotlin

• CURL

curl -L 'https://api.apify.com/v2/users/me/usage/monthly' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Request Collapse all

Base URL

https://api.apify.com

Auth

Security Scheme

httpBearerapiKey

Bearer Token

Parameters

date — query

ResponseClear

Click the Send API Request button above and see the response here!