Skip to main content
Version: 2.3

ActorRun

Represents information about an actor run, as returned by the Apify.call() or Apify.callTask() function. The object is almost equivalent to the JSON response of the Actor run Apify API endpoint and extended with certain fields. For more details, see Runs.

Properties

id

Type: string

Actor run ID


actId

Type: string

Actor ID


startedAt

Type: Date

Time when the actor run started


finishedAt

Type: Date

Time when the actor run finished. Contains null for running actors.


status

Type: string

Status of the run. For possible values, see Run lifecycle in Apify actor documentation.


meta

Type: Object<string, string>

Actor run meta-data. For example:

{
"origin": "API",
"clientIp": "1.2.3.4",
"userAgent": "ApifyClient/0.2.13 (Linux; Node/v8.11.3)"
}

stats

Type: Object<string, number>

An object containing various actor run statistics. For example:

{
"inputBodyLen": 22,
"restartCount": 0,
"workersUsed": 1,
}

Beware that object fields might change in future releases.


options

Type: Object<string, *>

Actor run options. For example:

{
"build": "latest",
"waitSecs": 0,
"memoryMbytes": 256,
"diskMbytes": 512
}

buildId

Type: string

ID of the actor build used for the run. For details, see Builds in Apify actor documentation.


buildNumber

Type: string

Number of the actor build used for the run. For example, 0.0.10.


exitCode

Type: number

Exit code of the actor run process. It's null if actor is still running.


defaultKeyValueStoreId

Type: string

ID of the default key-value store associated with the actor run. See KeyValueStore for details.


defaultDatasetId

Type: string

ID of the default dataset associated with the actor run. See Dataset for details.


defaultRequestQueueId

Type: string

ID of the default request queue associated with the actor run. See RequestQueue for details.


containerUrl

Type: string

URL on which the web server running inside actor run's Docker container can be accessed. For more details, see Container web server in Apify actor documentation.


output

Type: Object<string, *> | null | undefined

Contains output of the actor run. The value is null or undefined in case the actor is still running, or if you pass false to the fetchOutput option of Apify.call().

For example:

{
"contentType": "application/json; charset=utf-8",
"body": {
"message": "Hello world!"
}
}