Skip to main content
Version: Next

Run

Complete Actor run information including statistics and usage details.

Represents a single execution of an Actor with all its configuration, status, and resource usage information.

Hierarchy

  • Omit<Schemas[Run], keyof RunRePointed | keyof RunClientNarrowings>
  • RunRePointed
  • RunClientNarrowings
    • Run

Index

Properties

Properties

optionalinheritedaccountedChargedEventCounts

accountedChargedEventCounts?: null | {}
{
             *       "actor-start": 1,
             *       "page-crawled": 150
             *     }

A map of charged event types to the number of their charges that have already been accounted for billing. Present only for pay-per-event Actors.

inheritedactId

actId: string
HDSasDasz78YcAPEB

ID of the Actor that was run.

optionalinheritedactorTaskId

actorTaskId?: null | string
KJHSKHausidyaJKHs

ID of the Actor task, if the run was started from a task.

inheritedbuildId

buildId: string
7sT5jcggjjA9fNcxF

ID of the Actor build used for this run.

optionalinheritedbuildNumber

buildNumber?: null | string
0.0.36

Build number of the Actor build used for this run.

optionalinheritedchargedEventCounts

chargedEventCounts?: {}

Type declaration

    {
                 *       "actor-start": 1,
                 *       "page-crawled": 150,
                 *       "data-extracted": 75
                 *     }

    A map of charged event types to their counts. The keys are event type identifiers defined by the Actor's pricing model (pay-per-event), and the values are the number of times each event was charged during this run.

    optionalinheritedconsoleUrl

    consoleUrl?: string

    Format: uri

    https://console.apify.com/view/runs/HG7ML7M8z78YcAPEB

    URL of the run in Apify Console. Returned only by the Get Actor run endpoint.

    optionalinheritedcontainerUrl

    containerUrl?: string

    Format: uri

    https://g8kd8kbc5ge8.runs.apify.net

    URL of the container running the Actor.

    optionalinheritedcreatedByOrganizationMemberUserId

    createdByOrganizationMemberUserId?: string
    7sT5jcggjjA9fNcxF

    ID of the organization member who started the run. Present only for runs started on behalf of an organization.

    inheriteddefaultDatasetId

    defaultDatasetId: string
    wmKPijuyDnPZAPRMk

    ID of the default dataset for this run.

    inheriteddefaultKeyValueStoreId

    defaultKeyValueStoreId: string
    eJNzqsbPiopwJcgGQ

    ID of the default key-value store for this run.

    inheriteddefaultRequestQueueId

    defaultRequestQueueId: string
    FL35cSF7jrxr3BY39

    ID of the default request queue for this run.

    optionalinheritedeventUsage

    eventUsage?: {}

    Type declaration

      Cost breakdown of the pay-per-event charges in USD, keyed by event type. Present only for pay-per-event runs, and not when the run was started by the Actor's owner.

      optionalinheritedexitCode

      exitCode?: null | number
      0

      Exit code of the Actor run process.

      optionalinheritedexternalChargedTotalUsd

      externalChargedTotalUsd?: number
      0.5

      Total price in USD of the pay-per-event charges made to other users. Present only on multi-tenant Standby runs.

      optionalinheritedfinishedAt

      finishedAt?: null | Date

      Format: date-time

      2019-12-12T09:30:12.202Z

      Time when the Actor run finished.

      optionalinheritedgeneralAccess

      generalAccess?: null | RUN_GENERAL_ACCESS

      optionalinheritedgitBranchName

      gitBranchName?: null | string
      master

      Name of the git branch used for the Actor build.

      inheritedid

      id: string
      HG7ML7M8z78YcAPEB

      Unique identifier of the Actor run.

      optionalinheritedintegrationTracking

      integrationTracking?: { appId?: string; isAiTool?: boolean; platform?: string }

      Type declaration

      • optionalappId?: string

        ID of the integration app.

      • optionalisAiTool?: boolean
        false

        Whether the resource was created by an AI tool.

      • optionalplatform?: string
        zapier

        Name of the integration platform.

      Present only when the run was started by a third-party integration.

      optionalinheritedisContainerServerReady

      isContainerServerReady?: null | boolean
      true

      Whether the container's HTTP server is ready to accept requests.

      optionalinheritedisStatusMessageTerminal

      isStatusMessageTerminal?: null | boolean
      false

      Whether the status message is terminal (final).

      inheritedmeta

      meta: RunMeta

      optionalinheritedmetamorphs

      metamorphs?: null | RunMetamorphEvent[]

      inheritedoptions

      options: RunOptions

      optionalinheritedoutput

      output?: {}

      Type declaration

        {
                     *       "results": "https://api.apify.com/v2/datasets/wmKPijuyDnPZAPRMk/items"
                     *     }

        Output links of the run, generated from the output schema of the Actor build. Present only if the build defines an output schema.

        optionalinheritedplatformUsageBillingModel

        platformUsageBillingModel?: string
        USER

        Indicates which party covers platform usage costs for this run.

        optionalinheritedpricingInfo

        pricingInfo?: ActorRunPricingInfo

        optionalinheritedstandby

        standby?: null | { deployment: SINGLE_TENANT | MULTI_TENANT_OWNER_PAID | MULTI_TENANT_FREE_USERS | MULTI_TENANT_PAYING_USERS }

        Server Actor deployment of this run, null for runs not started by a Server Actor request.

        inheritedstartedAt

        startedAt: Date

        Format: date-time

        2019-11-30T07:34:24.202Z

        Time when the Actor run started.

        inheritedstats

        stats: RunStats

        inheritedstatus

        status: ValueOf<{ ABORTED: ABORTED; ABORTING: ABORTING; FAILED: FAILED; READY: READY; RUNNING: RUNNING; SUCCEEDED: SUCCEEDED; TIMED_OUT: TIMED-OUT; TIMING_OUT: TIMING-OUT }>

        optionalinheritedstatusMessage

        statusMessage?: null | string
        Actor is running

        Detailed message about the run status.

        optionalinheritedstorageIds

        storageIds?: ActorRunStorageIds

        optionalinheritedusage

        usage?: null | RunUsage

        optionalinheritedusageTotalUsd

        usageTotalUsd?: null | number
        0.2654

        Total cost in USD for this run. Represents what you actually pay. For run owners: includes platform usage (compute units) and/or event costs depending on the Actor's pricing model. For run non-owners: only available for pay-per-event Actors (event costs only). Requires authentication token to access.

        optionalinheritedusageUsd

        usageUsd?: null | RunUsage

        inheriteduserId

        userId: string
        7sT5jcggjjA9fNcxF

        ID of the user who started the run.

        Page Options