Skip to main content

Get run

GET 

/v2/actor-runs/:runId

This is not a single endpoint, but an entire group of endpoints that lets you retrieve the run or any of its default storages.

Convenience endpoints for Actor run default storages

Gets an object that contains all the details about a specific run of an Actor.

By passing the optional waitForFinish parameter the API endpoint will synchronously wait for the run to finish. This is useful to avoid periodic polling when waiting for Actor run to complete.

This endpoint does not require the authentication token. Instead, calls are authenticated using a hard-to-guess ID of the run. However, if you access the endpoint without the token, certain attributes, such as usageUsd and usageTotalUsd, will be hidden.

Request

Path Parameters

    runId string required

    Actor run ID.


    Example: 3KH8gEpp4d8uQSe8T

Query Parameters

    waitForFinish double

    The maximum number of seconds the server waits for the run to finish. By default it is 0, the maximum value is 60. If the run finishes in time then the returned run object will have a terminal status (e.g. SUCCEEDED), otherwise it will have a transitional status (e.g. RUNNING).


    Example: 60

Status 200

Response Headers
    {
    "data": {
    "id": "HG7ML7M8z78YcAPEB",
    "actId": "HDSasDasz78YcAPEB",
    "userId": "7sT5jcggjjA9fNcxF",
    "actorTaskId": "KJHSKHausidyaJKHs",
    "startedAt": "2019-11-30T07:34:24.202Z",
    "finishedAt": "2019-12-12T09:30:12.202Z",
    "status": "READY",
    "statusMessage": "Actor is running",
    "isStatusMessageTerminal": false,
    "meta": {
    "origin": "DEVELOPMENT",
    "clientIp": "string",
    "userAgent": "string",
    "scheduleId": "string",
    "scheduledAt": "2024-07-29T15:51:28.071Z"
    },
    "pricingInfo": {
    "apifyMarginPercentage": 0,
    "createdAt": "2024-07-29T15:51:28.071Z",
    "startedAt": "2024-07-29T15:51:28.071Z",
    "notifiedAboutFutureChangeAt": "2024-07-29T15:51:28.071Z",
    "notifiedAboutChangeAt": "2024-07-29T15:51:28.071Z",
    "reasonForChange": "string",
    "pricingModel": "PAY_PER_EVENT",
    "pricingPerEvent": {
    "actorChargeEvents": {}
    },
    "minimalMaxTotalChargeUsd": 0
    },
    "stats": {
    "inputBodyLen": 240,
    "migrationCount": 0,
    "rebootCount": 0,
    "restartCount": 0,
    "resurrectCount": 2,
    "memAvgBytes": 267874071.9,
    "memMaxBytes": 404713472,
    "memCurrentBytes": 0,
    "cpuAvgUsage": 33.7532101107538,
    "cpuMaxUsage": 169.650735534941,
    "cpuCurrentUsage": 0,
    "netRxBytes": 103508042,
    "netTxBytes": 4854600,
    "durationMillis": 248472,
    "runTimeSecs": 248.472,
    "metamorph": 0,
    "computeUnits": 0.13804
    },
    "chargedEventCounts": {
    "actor-start": 1,
    "page-crawled": 150,
    "data-extracted": 75
    },
    "options": {
    "build": "latest",
    "timeoutSecs": 300,
    "memoryMbytes": 1024,
    "diskMbytes": 2048,
    "maxItems": 1000,
    "maxTotalChargeUsd": 5
    },
    "buildId": "7sT5jcggjjA9fNcxF",
    "exitCode": 0,
    "generalAccess": "RESTRICTED",
    "defaultKeyValueStoreId": "eJNzqsbPiopwJcgGQ",
    "defaultDatasetId": "wmKPijuyDnPZAPRMk",
    "defaultRequestQueueId": "FL35cSF7jrxr3BY39",
    "storageIds": {
    "datasets": {
    "default": "wmKPijuyDnPZAPRMk"
    },
    "keyValueStores": {
    "default": "eJNzqsbPiopwJcgGQ"
    },
    "requestQueues": {
    "default": "FL35cSF7jrxr3BY39"
    }
    },
    "buildNumber": "0.0.36",
    "containerUrl": "https://g8kd8kbc5ge8.runs.apify.net",
    "isContainerServerReady": true,
    "gitBranchName": "master",
    "usage": {
    "ACTOR_COMPUTE_UNITS": 3,
    "DATASET_READS": 4,
    "DATASET_WRITES": 4,
    "KEY_VALUE_STORE_READS": 5,
    "KEY_VALUE_STORE_WRITES": 3,
    "KEY_VALUE_STORE_LISTS": 5,
    "REQUEST_QUEUE_READS": 2,
    "REQUEST_QUEUE_WRITES": 1,
    "DATA_TRANSFER_INTERNAL_GBYTES": 1,
    "DATA_TRANSFER_EXTERNAL_GBYTES": 3,
    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": 34,
    "PROXY_SERPS": 3
    },
    "usageTotalUsd": 0.2654,
    "usageUsd": {
    "ACTOR_COMPUTE_UNITS": 0.0003,
    "DATASET_READS": 0.0001,
    "DATASET_WRITES": 0.0001,
    "KEY_VALUE_STORE_READS": 0.0001,
    "KEY_VALUE_STORE_WRITES": 0.00005,
    "KEY_VALUE_STORE_LISTS": 0.0001,
    "REQUEST_QUEUE_READS": 0.0001,
    "REQUEST_QUEUE_WRITES": 0.0001,
    "DATA_TRANSFER_INTERNAL_GBYTES": 0.001,
    "DATA_TRANSFER_EXTERNAL_GBYTES": 0.003,
    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": 0.034,
    "PROXY_SERPS": 0.003
    },
    "metamorphs": [
    {
    "createdAt": "2019-11-30T07:39:24.202Z",
    "actorId": "nspoEjklmnsF2oosD",
    "buildId": "ME6oKecqy5kXDS4KQ",
    "inputKey": "INPUT-METAMORPH-1"
    }
    ]
    }
    }