Portal Community

Output Ports

PortOperationsDescription
successAll 11 operationsApify API responded successfully. Output schema varies by operation — see sections below.
errorAll 11 operationsAPI returned an error, the token was invalid, the actor was not found, or the run timed out. Always includes errorCode and status.

actor / run — Success Output

Returns immediately with the run object. The actor is still running at this point — use actorRun/getRun to poll for completion.

FieldTypeDescription
idstringUnique run ID. Use this in actorRun/getRun to check status.
actIdstringThe actor ID that was executed.
statusstringCurrent run status — will be RUNNING immediately after launch.
startedAtstring (ISO 8601)Timestamp when the run started.
finishedAtstring / nullnull until the run completes.
defaultDatasetIdstringDataset ID where the actor will write its output items.
defaultKeyValueStoreIdstringKey-value store ID for actor outputs like screenshots and logs.
statsobjectRuntime statistics: inputBodyLen, restartCount, durationMillis (available after completion).
{
  "id": "HG7ML7jfd9YDHg",
  "actId": "apify/web-scraper",
  "status": "RUNNING",
  "startedAt": "2026-05-23T14:00:00.000Z",
  "finishedAt": null,
  "defaultDatasetId": "WkzbQMuFYuamGv3",
  "defaultKeyValueStoreId": "eJNzqsbVe2dMoEKS",
  "stats": { "inputBodyLen": 420, "restartCount": 0, "durationMillis": 0 }
}

actor / runAndGetDatasetItems — Success Output

Returns after the actor completes. Output contains the run metadata plus the dataset items array.

FieldTypeDescription
runIdstringThe run ID that was executed.
statusstringFinal run status — SUCCEEDED, FAILED, or TIMED-OUT.
itemsarrayArray of dataset items extracted by the actor. Each item is a JSON object whose shape depends on the actor.
itemCountintegerTotal number of items returned.
datasetIdstringThe dataset ID the items were read from.
{
  "runId": "HG7ML7jfd9YDHg",
  "status": "SUCCEEDED",
  "itemCount": 3,
  "datasetId": "WkzbQMuFYuamGv3",
  "items": [
    { "url": "https://example.com/product/1", "title": "Widget Pro", "price": "$29.99" },
    { "url": "https://example.com/product/2", "title": "Widget Lite", "price": "$9.99" },
    { "url": "https://example.com/product/3", "title": "Widget Max", "price": "$49.99" }
  ]
}

dataset / getItems — Success Output

FieldTypeDescription
itemsarrayArray of dataset item objects. Field names match what the actor wrote.
countintegerNumber of items returned in this response (respects Limit).
offsetintegerThe offset value used in this request.
totalintegerTotal number of items in the full dataset (before offset/limit).

keyValueStore / getRecord — Success Output

FieldTypeDescription
keystringThe record key that was requested.
valueanyThe stored value. May be a JSON object, string, number, or base64-encoded binary depending on what the actor stored.
contentTypestringMIME type of the stored value (e.g. application/json, image/png, text/plain).
{
  "key": "OUTPUT",
  "contentType": "application/json",
  "value": {
    "pageTitle": "Acme Corp — Pricing",
    "extractedAt": "2026-05-23T14:05:00.000Z",
    "items": [...]
  }
}

actorRun / getRun — Success Output

Returns the full run object: id, actId, status, startedAt, finishedAt, defaultDatasetId, defaultKeyValueStoreId, stats (with durationMillis, inputBodyLen, restartCount), plus exitCode (integer) and isStatusMessageTerminal (boolean).

actorRun / getActorRuns and getUserRunsList — Success Output

Returns items (array of run summary objects — each with id, actId, status, startedAt, finishedAt), total (integer), offset, count.

actor / scrapeSingleUrl — Success Output

Returns url (the URL that was scraped), html (full rendered HTML, only if ExtractHtml=true), text (plain text, only if ExtractText=true), screenshotBase64 (PNG as base64, only if TakeScreenshot=true), statusCode (HTTP response code), loadedAt (ISO timestamp).

Error Port Output

All operations route to the error port on failure:

FieldTypeDescription
statusstringAlways "error".
errorCodestringApify API error type, e.g. actor-not-found, run-timed-out, invalid-token, dataset-not-found.
messagestringHuman-readable error description from the Apify API.
{
  "status": "error",
  "errorCode": "actor-not-found",
  "message": "Actor 'acme/nonexistent-actor' was not found."
}