Skip to content

Commit 1a7f79d

Browse files
mhamasTheoVasilis
andauthored
feat: explain usage usd on run and build objects (#677)
Co-authored-by: TheoVasilis <98097738+TheoVasilis@users.noreply.github.com>
1 parent 29e29d1 commit 1a7f79d

File tree

2 files changed

+26
-2
lines changed

2 files changed

+26
-2
lines changed

sources/platform/actors/running/usage_and_resources.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,10 @@ When you run an Actor it generates platform usage that's charged towards the use
8888
- **Proxy costs**: Residential or SERP proxy usage.
8989
- **Storage operations**: Read, write, and other operations towards key-value store, dataset, and request queue.
9090

91+
The platform usage can be represented either in raw units (e.g. gigabytes for data transfer, or number of writes for dataset operations), or in the dollar equivalents.
92+
Note that for technical reasons, every time you see the usage in dollars on a specific historical Actor run or build in the API or Apify Console, your current service pricing is used to compute the dollar amount,
93+
and hence it should be used only for informative purposes.
94+
9195
> For detailed information, FAQ, and, pricing see the [platform pricing page](https://apify.com/pricing/actors).
9296
9397

sources/platform/api_v2/api_v2_reference.apib

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -391,6 +391,10 @@ Note that for all the API endpoints that accept the `actorId` parameter to speci
391391
you can pass either the actor ID (e.g. `HG7ML7M8z78YcAPEB`) or a tilde-separated
392392
username of the actor owner and the actor name (e.g. `janedoe~my-actor`).
393393

394+
Some of the API endpoints return runs objects. Note that if any such run object contains usage in dollars, your effective unit pricing at the time of query
395+
has been used for computation of this dollar equivalent, and hence it should be used only for informative purposes. You can learn more
396+
about platform usage in the <a href="https://docs.apify.com/platform/actors/running/usage-and-resources#usage">documentation</a>.
397+
394398
## Actor collection [/v2/acts{?token,offset,limit,desc,my}]
395399

396400
+ Parameters
@@ -863,6 +867,8 @@ Gets an object that contains all the details about a specific build of an actor.
863867
By passing the optional `waitForFinish` parameter the API endpoint will synchronously wait for the build to finish.
864868
This is useful to avoid periodic polling when waiting for an actor build to finish.
865869

870+
This endpoint does not require the authentication token. The calls are authenticated using a hard-to-guess ID of the build.
871+
866872
+ Parameters
867873

868874
+ buildId: `soSkq9ekdmfOslopH` (string, required) - ID of the build you want to get, found in the build's `Info` tab.
@@ -1293,7 +1299,7 @@ Gets an object that contains all the details about a specific run of an actor.
12931299
By passing the optional `waitForFinish` parameter the API endpoint will synchronously wait for the run to finish.
12941300
This is useful to avoid periodic polling when waiting for actor run to complete.
12951301

1296-
This endpoint does not require the authentication token, the calls are authenticated using a hard-to-guess ID of the run.
1302+
This endpoint does not require the authentication token. The calls are authenticated using a hard-to-guess ID of the run.
12971303

12981304
+ Parameters
12991305

@@ -1463,6 +1469,10 @@ Note that for all the API endpoints that accept the `actorTaskId` parameter to s
14631469
you can pass either the task ID (e.g. `HG7ML7M8z78YcAPEB`) or a tilde-separated
14641470
username of the task's owner and the task's name (e.g. `janedoe~my-task`).
14651471

1472+
Some of the API endpoints return runs objects. Note that if any such run object contains usage in dollars, your effective unit pricing at the time of query
1473+
has been used for computation of this dollar equivalent, and hence it should be used only for informative purposes. You can learn more
1474+
about platform usage in the <a href="https://docs.apify.com/platform/actors/running/usage-and-resources#usage">documentation</a>.
1475+
14661476
## Task collection [/v2/actor-tasks{?token,offset,limit,desc}]
14671477

14681478
+ Parameters
@@ -2085,6 +2095,10 @@ In order to save new items to the dataset, send HTTP POST request with JSON payl
20852095

20862096
The API endpoints described in this section enable you to manage Apify actor runs.
20872097

2098+
Note that if any returned run object contains usage in dollars, your effective unit pricing at the time of query
2099+
has been used for computation of this dollar equivalent, and hence it should be used only for informative purposes.
2100+
You can learn more about platform usage in the <a href="https://docs.apify.com/platform/actors/running/usage-and-resources#usage">documentation</a>.
2101+
20882102
## Run collection [/v2/actor-runs{?token,offset,limit,desc,status}]
20892103

20902104
### Get user runs list [GET]
@@ -2185,7 +2199,7 @@ Gets an object that contains all the details about a specific run of an actor.
21852199
By passing the optional `waitForFinish` parameter the API endpoint will synchronously wait for the run to finish.
21862200
This is useful to avoid periodic polling when waiting for actor run to complete.
21872201

2188-
This endpoint does not require the authentication token, the calls are authenticated using a hard-to-guess ID of the run.
2202+
This endpoint does not require the authentication token. The calls are authenticated using a hard-to-guess ID of the run.
21892203

21902204
+ Parameters
21912205

@@ -2313,6 +2327,10 @@ you will also need to specify `isStatusMessageTerminal=true`. In the absence of
23132327

23142328
The API endpoints described in this section enable you to manage Apify actor builds.
23152329

2330+
Note that if any returned build object contains usage in dollars, your effective unit pricing at the time of query
2331+
has been used for computation of this dollar equivalent, and hence it should be used only for informative purposes.
2332+
You can learn more about platform usage in the <a href="https://docs.apify.com/platform/actors/running/usage-and-resources#usage">documentation</a>.
2333+
23162334
## Build collection [/v2/actor-builds{?token,offset,limit,desc}]
23172335

23182336
+ Parameters
@@ -2357,6 +2375,8 @@ Gets an object that contains all the details about a specific build of an actor.
23572375
By passing the optional `waitForFinish` parameter the API endpoint will synchronously wait for the build to finish.
23582376
This is useful to avoid periodic polling when waiting for an actor build to finish.
23592377

2378+
This endpoint does not require the authentication token. The calls are authenticated using a hard-to-guess ID of the build.
2379+
23602380
+ Parameters
23612381

23622382
+ buildId: `soSkq9ekdmfOslopH` (string, required) - ID of the build you want to get, found in the build's `Info` tab.

0 commit comments

Comments
 (0)