v3

latestOpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB
Actors

Get Actor

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

get/v2/actors/{actorId}

Path parameters

actorIdstring required
Example:janedoe~my-actor

Actor ID or a tilde-separated owner's username and Actor name.

Response

Example response

{
  "data": {
    "id": "zdc3Pyhyz3m8vjDeM",
    "userId": "wRsJZtadYvn4mBZmm",
    "name": "MyActor",
    "username": "jane35",
    "description": "My favourite actor!",
    "actorPermissionLevel": "LIMITED_PERMISSIONS",
    "createdAt": "2019-07-08T11:27:57.401Z",
    "modifiedAt": "2019-07-08T14:01:05.546Z",
    "stats": {
      "totalBuilds": 9,
      "totalRuns": 16,
      "totalUsers": 6,
      "totalUsers7Days": 2,
      "totalUsers30Days": 6,
      "totalUsers90Days": 6,
      "totalMetamorphs": 2,
      "lastRunStartedAt": "2019-07-08T14:01:05.546Z",
      "actorReviewCount": 69,
      "actorReviewRating": 4.7,
      "bookmarkCount": 1269,
      "publicActorRunStats30Days": {
        "ABORTED": 2542,
        "FAILED": 1234,
        "SUCCEEDED": 732805,
        "TIMED-OUT": 12556,
        "TOTAL": 749137
      }
    },
    "versions": [
      {
        "versionNumber": "0.0",
        "envVars": [
          {
            "name": "MY_ENV_VAR",
            "value": "my-value"
          }
        ],
        "buildTag": "latest",
        "sourceFiles": [
          {
            "format": "TEXT",
            "content": "console.log('This is the main.js file');",
            "name": "src/main.js"
          }
        ]
      }
    ],
    "defaultRunOptions": {
      "build": "latest",
      "timeoutSecs": 3600,
      "memoryMbytes": 2048,
      "forcePermissionLevel": "LIMITED_PERMISSIONS"
    },
    "exampleRunInput": {
      "body": "{ \"helloWorld\": 123 }",
      "contentType": "application/json; charset=utf-8"
    },
    "deploymentKey": "ssh-rsa AAAA ...",
    "title": "My Actor",
    "taggedBuilds": {
      "latest": {
        "buildId": "z2EryhbfhgSyqj6Hn",
        "buildNumber": "0.0.2",
        "finishedAt": "2019-06-10T11:15:49.286Z"
      },
      "beta": {
        "buildId": "abc123def456",
        "buildNumber": "1.0.5",
        "finishedAt": "2019-07-15T14:30:00.000Z"
      }
    },
    "seoTitle": "Web Scraper",
    "seoDescription": "Crawls websites using Chrome and extracts data from pages using JavaScript.",
    "pictureUrl": "https://apify-image-uploads-prod.s3.amazonaws.com/.../actor-picture.png",
    "standbyUrl": "https://my-actor.apify.actor",
    "notice": "NONE",
    "categories": [
      "DEVELOPER_TOOLS",
      "OPEN_SOURCE"
    ]
  }
}