Run

Represents an Actor run and its associated data.

Index

Properties

• accounted_charged_event_counts
• act_id
• actor_task_id
• build_id
• build_number
• charged_event_counts
• console_url
• container_url
• created_by_organization_member_user_id
• default_dataset_id
• default_key_value_store_id
• default_request_queue_id
• event_usage
• exit_code
• external_charged_total_usd
• finished_at
• general_access
• git_branch_name
• id
• integration_tracking
• is_container_server_ready
• is_status_message_terminal
• meta
• metamorphs
• model_config
• options
• output
• platform_usage_billing_model
• pricing_info
• standby
• started_at
• stats
• status
• status_message
• storage_ids
• usage
• usage_total_usd
• usage_usd
• user_id

Properties

accounted_charged_event_counts

accounted_charged_event_counts: dict[str, Any] | None

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.

act_id

act_id: str

ID of the Actor that was run.

actor_task_id

actor_task_id: str | None

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

build_id

build_id: str

ID of the Actor build used for this run.

build_number

build_number: str | None

Build number of the Actor build used for this run.

charged_event_counts

charged_event_counts: dict[str, int] | None

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.

console_url

console_url: AnyUrl | None

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

container_url

container_url: AnyUrl | None

URL of the container running the Actor.

created_by_organization_member_user_id

created_by_organization_member_user_id: str | None

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

default_dataset_id

default_dataset_id: str

ID of the default dataset for this run.

default_key_value_store_id

default_key_value_store_id: str

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

default_request_queue_id

default_request_queue_id: str

ID of the default request queue for this run.

event_usage

event_usage: dict[str, RunEventUsage] | None

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.

exit_code

exit_code: int | None

Exit code of the Actor run process.

external_charged_total_usd

external_charged_total_usd: float | None

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

finished_at

finished_at: AwareDatetime | None

Time when the Actor run finished.

general_access

general_access: GeneralAccess | None

General access level for the Actor run.

git_branch_name

git_branch_name: str | None

Name of the git branch used for the Actor build.

id

id: str

Unique identifier of the Actor run.

integration_tracking

integration_tracking: IntegrationTracking | None

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

is_container_server_ready

is_container_server_ready: bool | None

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

is_status_message_terminal

is_status_message_terminal: bool | None

Whether the status message is terminal (final).

meta

meta: RunMeta

Metadata about the Actor run.

metamorphs

metamorphs: list[RunMetamorphEvent] | None

List of metamorph events that occurred during the run.

model_config

model_config: Undefined

options

options: RunOptions

Configuration options for the Actor run.

output

output: dict[str, AnyUrl] | None

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

platform_usage_billing_model

platform_usage_billing_model: str | None

Indicates which party covers platform usage costs for this run.

pricing_info

pricing_info: (((PayPerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo) | FlatPricePerMonthActorPricingInfo) | FreeActorPricingInfo) | None

Pricing information for the Actor.

standby

standby: RunStandby | None

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

started_at

started_at: AwareDatetime

Time when the Actor run started.

stats

stats: RunStats

Statistics of the Actor run.

status

status: ActorJobStatus

Current status of the Actor run.

status_message

status_message: str | None

Detailed message about the run status.

storage_ids

storage_ids: StorageIds | None

A map of aliased storage IDs associated with this run, grouped by storage type.

usage

usage: RunUsage | None

Resource usage statistics for the run.

usage_total_usd

usage_total_usd: float | None

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.

usage_usd

usage_usd: RunUsageUsd | None

Platform usage costs breakdown in USD. Only present if you own the run and are paying for platform usage (pay-per-usage or pay-per-event with usage costs like Standby Actors). Not available for standard pay-per-event Actors. Requires authentication token to access.

user_id

user_id: str

ID of the user who started the run.