Get list of Actor's runs
Changed onGets the list of runs of a specific Actor. The response is a list of objects, where each object contains basic information about a single Actor run.
The endpoint supports pagination using the limit and offset parameters and it will not return more than 1000 array elements.
By default, the records are sorted by the startedAt field in ascending order, therefore you can use pagination to incrementally fetch all records while new ones are still being created. To sort the records in descending order, use desc=1 parameter. You can also filter runs by status (available statuses).
Request
- Base URLhttps://api.apify.com
- Auth
- HTTP bearer
- or API key in query parameter token
Path parameters
Actor ID or the username of the Actor owner and the Actor name, separated by a tilde (~).
Query parameters
Number of items that should be skipped at the start. The default value is 0.
Maximum number of items to return. The default value as well as the maximum is 1000.
If true or 1 then the objects are sorted by the startedAt field in descending order. By default, they are sorted in ascending order.
Single status or comma-separated list of statuses, see (available statuses). Used to filter runs by the specified statuses only.
[ "SUCCEEDED" ]
Filter runs that started after the specified date and time (inclusive). The value must be a valid ISO 8601 datetime string (UTC).
Filter runs that started before the specified date and time (inclusive). The value must be a valid ISO 8601 datetime string (UTC).
Single Actor Standby deployment or comma-separated list of deployments (SINGLE_TENANT, MULTI_TENANT_FREE_USERS, MULTI_TENANT_PAYING_USERS or MULTI_TENANT_OWNER_PAID). Used to filter Actor Standby runs by the pool that serves them. Requires the status parameter with only non-terminal statuses (READY, RUNNING, TIMING-OUT or ABORTING).
[ "SINGLE_TENANT" ]
Response
Example response
{
"data": {
"total": 1,
"limit": 1000,
"count": 1,
"items": [
{
"id": "HG7ML7M8z78YcAPEB",
"actId": "HDSasDasz78YcAPEB",
"userId": "7sT5jcggjjA9fNcxF",
"actorTaskId": "KJHSKHausidyaJKHs",
"startedAt": "2019-11-30T07:34:24.202Z",
"finishedAt": "2019-12-12T09:30:12.202Z",
"buildId": "HG7ML7M8z78YcAPEB",
"buildNumber": "0.0.2",
"buildNumberInt": 10000,
"meta": {
"actorRunId": "HG7ML7M8z78YcAPEB",
"webhookDispatchId": "asdLZtadYvn4mBZmm",
"scheduledAct2Id": "c6KfSgoQzFhMk3etc",
"scheduledActorTaskId": "c6KfSgoQzFhMk3etc"
},
"usageTotalUsd": 0.2,
"defaultKeyValueStoreId": "sfAjeR4QmeJCQzTfe",
"defaultDatasetId": "3ZojQDdFTsyE7Moy4",
"defaultRequestQueueId": "so93g2shcDzK3pA85",
"standby": {
"deployment": "MULTI_TENANT_PAYING_USERS"
}
}
]
}
}Changes
- warning
added the new
MULTI_TENANT_FREE_USERSenum value to the//////response property for the response status - warning
added the new
MULTI_TENANT_OWNER_PAIDenum value to the//////response property for the response status - warning
added the new
MULTI_TENANT_PAYING_USERSenum value to the//////response property for the response status - warning
added the new
SINGLE_TENANTenum value to the//////response property for the response status
- warning
- breaking
the
////response's property type changed fromobjectto no type for status - breaking
removed the required property
/////from the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added
subschema #2to the////response propertyanyOflist for the response status
- breaking