Skip to content

Commit caebb48

Browse files
m-murasovsm-murasovs
authored
Add user usage endpoints to API docs (#461)
1 parent b2d6005 commit caebb48

File tree

1 file changed

+94
-5
lines changed

1 file changed

+94
-5
lines changed

‎content/docs/api_v2/api_v2_reference.apib

Lines changed: 94 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3623,6 +3623,47 @@ The user account is identified by the provided authentication token.
36233623
+ Attributes
36243624
- data (UserPrivateInfo, required)
36253625

3626+
3627+
## Monthly usage [/v2/users/me/usage/monthly{?token,date}]
3628+
3629+
+ Parameters
3630+
3631+
+ token: `rWLaYmvZeK55uatRrZib4xbZf` (string, required) - API authentication token.
3632+
+ date: `2020-06-14` (string, optional) - Date in the YYYY-MM-DD format.
3633+
3634+
3635+
### Get monthly usage [GET]
3636+
3637+
Returns a complete summary of your usage for the current usage cycle,
3638+
an overall sum, as well as a daily breakdown of usage. It is the same information you will see on your account's
3639+
[Billing page](https://console.apify.com/billing#/usage). The information
3640+
includes your use of storage, data transfer, and request queue usage.
3641+
3642+
Using the `date` parameter will show your usage in the usage cycle that includes that date.
3643+
3644+
+ Response 200 (application/json)
3645+
3646+
+ Attributes
3647+
- data (MonthlyUsage, required)
3648+
3649+
3650+
## Account and usage limits [/v2/users/me/limits{?token}]
3651+
3652+
+ Parameters
3653+
3654+
+ token: `rWLaYmvZeK55uatRrZib4xbZf` (string, required) - API authentication token.
3655+
3656+
### Get limits [GET]
3657+
3658+
Returns a complete summary of your account's limits. It is the same information you will see on your account's
3659+
[Limits page](https://console.apify.com/billing#/limits). The returned data includes the current usage cycle,
3660+
a summary of your limits, and your current usage.
3661+
3662+
+ Response 200 (application/json)
3663+
3664+
+ Attributes
3665+
- data (AccountLimits, required)
3666+
36263667
# Data Structures
36273668

36283669
## Actor (object)
@@ -3838,7 +3879,7 @@ The user account is identified by the provided authentication token.
38383879
## ListOfVersions (array)
38393880
- (object)
38403881
- versionNumber: `0.1` (string, required)
3841-
- envVars: (array, nullable)
3882+
- envVars (array, nullable)
38423883
- sourceType: `SOURCE_FILES` (VersionSourceType, required)
38433884
- applyEnvVarsToBuild: false (boolean, nullable)
38443885
- buildTag: `latest` (string, required)
@@ -3862,21 +3903,21 @@ The user account is identified by the provided authentication token.
38623903
- (object)
38633904
- versionNumber: `0.2` (string, required)
38643905
- sourceType: `GIT_REPO` (VersionSourceType, required)
3865-
- envVars: (array, nullable)
3906+
- envVars (array, nullable)
38663907
- applyEnvVarsToBuild: false (boolean, nullable)
38673908
- buildTag: `latest` (string, required)
38683909
- gitRepoUrl: `https://github.com/jane35/my-actor` (string, required)
38693910
- (object)
38703911
- versionNumber: `0.3` (string, required)
38713912
- sourceType: `TARBALL` (VersionSourceType, required)
3872-
- envVars: (array, nullable)
3913+
- envVars (array, nullable)
38733914
- applyEnvVarsToBuild: false (boolean, nullable)
38743915
- buildTag: `latest` (string, required)
38753916
- tarballUrl: `https://github.com/jane35/my-actor/archive/master.zip` (string, required)
38763917
- (object)
38773918
- versionNumber: `0.4` (string, required)
38783919
- sourceType: `GITHUB_GIST` (VersionSourceType, required)
3879-
- envVars: (array, nullable)
3920+
- envVars (array, nullable)
38803921
- applyEnvVarsToBuild: false (boolean, nullable)
38813922
- buildTag: `latest` (string, required)
38823923
- gitHubGistUrl: `https://gist.github.com/jane35/e51feb784yu89` (string, required)
@@ -4311,7 +4352,7 @@ The user account is identified by the provided authentication token.
43114352
- userData (object)
43124353
- label: `DETAIL` (string, nullable)
43134354
- image: `https://picserver1.eu` (string, nullable)
4314-
- handledAt: `2019-06-16T10:23:31.607Z` (object, nullable)
4355+
- handledAt: `2019-06-16T10:23:31.607Z` (string, nullable)
43154356

43164357
## UserPublicInfo (object)
43174358
- username: `d7b9MDYsbtX5L7XAj` (string, required)
@@ -4366,6 +4407,54 @@ The user account is identified by the provided authentication token.
43664407
- supportLevel: `COMMUNITY` (string, required)
43674408
- availableAddOns (array, required)
43684409

4410+
## MonthlyUsage (object)
4411+
- usageCycle (object, required)
4412+
- startAt: `2022-10-02T00:00:00.000Z` (string, required)
4413+
- endAt: `2022-11-01T23:59:59.999Z` (string, required)
4414+
- monthlyServiceUsage (object, required)
4415+
- USAGE_ITEM (object, required)
4416+
- quantity: `2.784475` (number, required)
4417+
- baseAmountUsd: `0.69611875` (number, required)
4418+
- baseUnitPriceUsd: `0.25` (number, required)
4419+
- amountAfterVolumeDiscountUsd: `0.69611875` (number, required)
4420+
- dailyServiceUsages (array, required)
4421+
- (object, required)
4422+
- date: `2022-10-02T00:00:00.000Z` (string, required)
4423+
- serviceUsage (object, required)
4424+
- SERVICE_USAGE_ITEM (object, required)
4425+
- quantity: `60` (number, required)
4426+
- baseAmountUsd: `0.00030000000000000003` (number, required)
4427+
4428+
- amountAfterVolumeDiscountUsd: `0.69611875` (number, required)
4429+
- totalUsageCreditsUsd: `0.04743857919705913` (number, required)
4430+
- totalUsageCreditsUsdBeforeVolumeDiscount: `0.786143673840067` (number, required)
4431+
- totalUsageCreditsUsdAfterVolumeDiscount: `0.7861436738400671` (number, required)
4432+
4433+
## AccountLimits (object)
4434+
- monthlyUsageCycle (object, required)
4435+
- startAt: `2022-10-02T00:00:00.000Z` (string, required)
4436+
- endAt: `2022-11-01T23:59:59.999Z` (string, required)
4437+
- limits (object, required)
4438+
- maxMonthlyUsageUsd: `300` (number, required)
4439+
- maxMonthlyActorComputeUnits: `1000` (number, required)
4440+
- maxMonthlyExternalDataTransferGbytes: `7` (number, required)
4441+
- maxMonthlyProxySerps: `50` (number, required)
4442+
- maxMonthlyResidentialProxyGbytes: `0.5` (number, required)
4443+
- maxActorMemoryGbytes: `16` (number, required)
4444+
- maxActorCount: `100` (number, required)
4445+
- maxActorTaskCount: `1000` (number, required)
4446+
- maxTeamAccountSeatCount: `9` (number, required)
4447+
- current (object, required)
4448+
- monthlyUsageUsd: `43` (number, required)
4449+
- monthlyActorComputeUnits: `500.784475` (number, required)
4450+
- monthlyExternalDataTransferGbytes: `3.008619039319455624` (number, required)
4451+
- monthlyProxySerps: `34` (number, required)
4452+
- monthlyResidentialProxyGbytes: `0.4` (number, required)
4453+
- actorMemoryGbytes: `8` (number, required)
4454+
- actorCount: `31` (number, required)
4455+
- actorTaskCount: `130` (number, required)
4456+
- teamAccountSeatCount: `5` (number, required)
4457+
43694458
## Webhook (object)
43704459
- id: `YiKoxjkaS9gjGTqhF` (string, required)
43714460
- createdAt: `2019-12-12T07:34:14.202Z` (string, required)

0 commit comments

Comments
 (0)