|
15 | 15 | - A tilde-separated combination of the Actor owner's username and the Actor name (e.g., `janedoe~my-actor`). |
16 | 16 |
|
17 | 17 | - name: Actors/Actor versions |
18 | | - x-displayName: Actor versions |
| 18 | + x-displayName: Actor versions - Introduction |
19 | 19 | x-parent-tag-name: Actors |
20 | 20 | x-legacy-doc-urls: |
21 | 21 | - '#/reference/actors/version-collection' |
|
44 | 44 | For more information about source code and Actor versions, check out [Source code](https://docs.apify.com/platform/actors/development/actor-definition/source-code) |
45 | 45 | in Actors documentation. |
46 | 46 | - name: Actors/Actor builds |
47 | | - x-displayName: Actor builds |
| 47 | + x-displayName: Actor builds - Introduction |
48 | 48 | x-parent-tag-name: Actors |
49 | 49 | x-legacy-doc-urls: |
50 | 50 | - '#/reference/actors/build-collection' |
|
56 | 56 | description: | |
57 | 57 | The API endpoints in this section allow you to manage your Apify Actors builds. |
58 | 58 | - name: Actors/Actor runs |
59 | | - x-displayName: Actor runs |
| 59 | + x-displayName: Actor runs - Introduction |
60 | 60 | x-parent-tag-name: Actors |
61 | 61 | x-legacy-doc-urls: |
62 | 62 | - '#/reference/actors/run-collection' |
|
70 | 70 | - '#tag/ActorsRun-actor-synchronously' |
71 | 71 | - '#/reference/actors/run-actor-synchronously-and-get-dataset-items' |
72 | 72 | - '#tag/ActorsRun-Actor-synchronously-and-get-dataset-items' |
| 73 | + - '#/reference/actors/last-run-object-and-its-storages' |
| 74 | + - '#tag/ActorsLast-run-object-and-its-storages' |
73 | 75 | description: | |
74 | 76 | The API endpoints in this section allow you to manage your Apify Actors runs. |
75 | 77 |
|
|
78 | 80 | For more information about platform usage and resource calculations, see the [Usage and Resources documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage). |
79 | 81 | x-trait: 'true' |
80 | 82 | - name: Actors/Webhook collection |
81 | | - x-displayName: Webhook collection |
| 83 | + x-displayName: Webhook collection - Introduction |
82 | 84 | x-parent-tag-name: Actors |
83 | 85 | x-legacy-doc-urls: |
84 | 86 | - '#/reference/actors/webhook-collection' |
85 | 87 | - '#tag/ActorsWebhook-collection' |
86 | 88 | description: | |
87 | 89 | The API endpoint in this section allows you to get a list of webhooks of a specific Actor. |
88 | 90 | x-trait: 'true' |
89 | | -- name: Actors/Last run object and its storages |
90 | | - x-displayName: Last run object and its storages |
91 | | - x-parent-tag-name: Actors |
92 | | - x-legacy-doc-urls: |
93 | | - - '#/reference/actors/last-run-object-and-its-storages' |
94 | | - - '#tag/ActorsLast-run-object-and-its-storages' |
95 | | - x-trait: 'true' |
96 | | - description: | |
97 | | - This is not a single endpoint, but an entire group of endpoints that lets you to |
98 | | - retrieve and manage the last run of given Actor or any of its default storages. |
99 | | - All the endpoints require an authentication token. |
100 | | -
|
101 | | - The endpoints accept the same HTTP methods and query parameters as |
102 | | - the respective storage endpoints. |
103 | | - The base path represents the last Actor run object is: |
104 | | -
|
105 | | - `/v2/acts/{actorId}/runs/last{?token,status}` |
106 | | -
|
107 | | - Using the `status` query parameter you can ensure to only get a run with a certain status |
108 | | - (e.g. `status=SUCCEEDED`). The output of this endpoint and other query parameters |
109 | | - are the same as in the [Run object](#/reference/actors/run-object) endpoint. |
110 | | -
|
111 | | - In order to access the default storages of the last Actor run, i.e. log, key-value |
112 | | - store, dataset and request queue, use the following endpoints: |
113 | | -
|
114 | | - * `/v2/acts/{actorId}/runs/last/log{?token,status}` |
115 | | - * `/v2/acts/{actorId}/runs/last/key-value-store{?token,status}` |
116 | | - * `/v2/acts/{actorId}/runs/last/dataset{?token,status}` |
117 | | - * `/v2/acts/{actorId}/runs/last/request-queue{?token,status}` |
118 | | -
|
119 | | - These API endpoints have the same usage as the equivalent storage endpoints. |
120 | | - For example, `/v2/acts/{actorId}/runs/last/key-value-store` has the same HTTP method and parameters |
121 | | - as the [Key-value store object](#/reference/key-value-stores/store-object) endpoint. |
122 | | -
|
123 | | - Additionally, each of the above API endpoints supports all sub-endpoints |
124 | | - of the original one: |
125 | | -
|
126 | | - #### Key-value store |
127 | | -
|
128 | | - * `/v2/acts/{actorId}/runs/last/key-value-store/keys{?token,status}` [Key collection](#/reference/key-value-stores/key-collection) |
129 | | - * `/v2/acts/{actorId}/runs/last/key-value-store/records/{recordKey}{?token,status}` [Record](#/reference/key-value-stores/record) |
130 | | -
|
131 | | - #### Dataset |
132 | | -
|
133 | | - * `/v2/acts/{actorId}/runs/last/dataset/items{?token,status}` [Item collection](#/reference/datasets/item-collection) |
134 | | -
|
135 | | - #### Request queue |
136 | | -
|
137 | | - * `/v2/acts/{actorId}/runs/last/request-queue/requests{?token,status}` [Request |
138 | | - collection](#/reference/request-queues/request-collection) |
139 | | - * `/v2/acts/{actorId}/runs/last/request-queue/requests/{requestId}{?token,status}` |
140 | | - [Request collection](#/reference/request-queues/request) |
141 | | - * `/v2/acts/{actorId}/runs/last/request-queue/head{?token,status}` [Queue head](#/reference/request-queues/queue-head) |
142 | | -
|
143 | | - For example, to download data from a dataset of the last succeeded Actor run in XML format, |
144 | | - send HTTP GET request to the following URL: |
145 | | -
|
146 | | - ``` |
147 | | - https://api.apify.com/v2/acts/{actorId}/runs/last/dataset/items?token={yourApiToken}&format=xml&status=SUCCEEDED |
148 | | - ``` |
149 | | -
|
150 | | - In order to save new items to the dataset, send HTTP POST request with JSON payload to the same URL. |
151 | 91 | - name: Actor builds |
152 | 92 | x-displayName: Actor builds - Introduction |
153 | 93 | x-legacy-doc-urls: |
|
186 | 126 |
|
187 | 127 | You can learn more about platform usage in the [documentation](https://docs.apify.com/platform/actors/running/usage-and-resources#usage). |
188 | 128 | - name: Actor tasks |
189 | | - x-displayName: Actor tasks |
| 129 | + x-displayName: Actor tasks - Introduction |
190 | 130 | x-legacy-doc-urls: |
191 | 131 | - '#/reference/actor-tasks' |
192 | 132 | - '#tag/Actor-tasks' |
|
227 | 167 | - name: Storage |
228 | 168 | x-displayName: |
229 | 169 | - name: Storage/Datasets |
230 | | - x-displayName: Datasets |
| 170 | + x-displayName: Datasets - Introduction |
231 | 171 | x-parent-tag-name: Storage |
232 | 172 | x-legacy-doc-urls: |
233 | 173 | - '#/reference/datasets' |
|
257 | 197 | ::: |
258 | 198 | x-trait: 'true' |
259 | 199 | - name: Storage/Key-value stores |
260 | | - x-displayName: Key-value stores |
| 200 | + x-displayName: Key-value stores - Introduction |
261 | 201 | x-parent-tag-name: Storage |
262 | 202 | x-legacy-doc-urls: |
263 | 203 | - '#/reference/key-value-stores/key-collection' |
|
287 | 227 | ::: |
288 | 228 | x-trait: 'true' |
289 | 229 | - name: Storage/Request queues |
290 | | - x-displayName: Request queues |
| 230 | + x-displayName: Request queues - Introduction |
291 | 231 | x-parent-tag-name: Storage |
292 | 232 | x-legacy-doc-urls: |
293 | 233 | - '#/reference/request-queues' |
|
327 | 267 | - name: Webhooks |
328 | 268 | x-displayName: |
329 | 269 | - name: Webhooks/Webhooks |
330 | | - x-displayName: Webhooks |
| 270 | + x-displayName: Webhooks - Introduction |
331 | 271 | x-parent-tag-name: Webhooks |
332 | 272 | x-legacy-doc-urls: |
333 | 273 | - '#/reference/webhooks' |
|
351 | 291 |
|
352 | 292 | For more information see [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks). |
353 | 293 | - name: Webhooks/Webhook dispatches |
354 | | - x-displayName: Webhook dispatches |
| 294 | + x-displayName: Webhook dispatches - Introduction |
355 | 295 | x-parent-tag-name: Webhooks |
356 | 296 | x-legacy-doc-urls: |
357 | 297 | - '#/reference/webhook-dispatches' |
|
362 | 302 | - '#tag/Webhook-dispatchesWebhook-dispatch-object' |
363 | 303 | description: This section describes API endpoints to get webhook dispatches. |
364 | 304 | - name: Schedules |
365 | | - x-displayName: Schedules |
| 305 | + x-displayName: Schedules - Introduction |
366 | 306 | x-legacy-doc-urls: |
367 | 307 | - '#/reference/schedules' |
368 | 308 | - '#tag/Schedules' |
|
388 | 328 | For details, see the documentation of the [Get schedule](#/reference/schedules/schedule-object/get-schedule) endpoint. |
389 | 329 | x-trait: 'true' |
390 | 330 | - name: Store |
391 | | - x-displayName: Store |
| 331 | + x-displayName: Store - Introduction |
392 | 332 | x-legacy-doc-urls: |
393 | 333 | - '#/reference/store' |
394 | 334 | - '#tag/Store' |
|
406 | 346 | ::: |
407 | 347 | x-trait: true |
408 | 348 | - name: Logs |
409 | | - x-displayName: Logs |
| 349 | + x-displayName: Logs - Introduction |
410 | 350 | x-legacy-doc-urls: |
411 | 351 | - '#/reference/logs' |
412 | 352 | - '#tag/Logs' |
|
425 | 365 | ::: |
426 | 366 | x-trait: true |
427 | 367 | - name: Users |
428 | | - x-displayName: Users |
| 368 | + x-displayName: Users - Introduction |
429 | 369 | x-legacy-doc-urls: |
430 | 370 | - '#/reference/users' |
431 | 371 | - '#tag/Users' |
|
0 commit comments