APapify
Actor tasks

Get list of Actor task's runs

Changed on

Get a list of runs of a specific task. The response is a list of objects, where each object contains essential information about a single task run.

The endpoint supports pagination using the limit and offset parameters, and it does not return more than a 1000 array elements.

By default, the records are sorted by the startedAt field in ascending order; therefore you can use pagination to incrementally fetch all records while new ones are still being created. To sort the records in descending order, use the desc=1 parameter. You can also filter runs by status (available statuses).

get/v2/actor-tasks/{actorTaskId}/runs

Request

  • Base URL
    https://api.apify.com
  • Auth
    • HTTP bearer
    • or API key in query parameter token

Path parameters

actorTaskIdstring required
Example:janedoe~my-task

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

Query parameters

offsetnumber double

Number of items that should be skipped at the start. The default value is 0.

limitnumber double
Example:1000

Maximum number of items to return. The default value as well as the maximum is 1000.

descboolean
Example:true

If true or 1 then the objects are sorted by the startedAt field in descending order. By default, they are sorted in ascending order.

statusstring[]

Single status or comma-separated list of statuses, see (available statuses). Used to filter runs by the specified statuses only.

[
  "SUCCEEDED"
]

Response

Example response

{
  "data": {
    "total": 1,
    "limit": 1000,
    "count": 1,
    "items": [
      {
        "id": "HG7ML7M8z78YcAPEB",
        "actId": "HDSasDasz78YcAPEB",
        "userId": "7sT5jcggjjA9fNcxF",
        "actorTaskId": "KJHSKHausidyaJKHs",
        "startedAt": "2019-11-30T07:34:24.202Z",
        "finishedAt": "2019-12-12T09:30:12.202Z",
        "buildId": "HG7ML7M8z78YcAPEB",
        "buildNumber": "0.0.2",
        "buildNumberInt": 10000,
        "meta": {
          "actorRunId": "HG7ML7M8z78YcAPEB",
          "webhookDispatchId": "asdLZtadYvn4mBZmm",
          "scheduledAct2Id": "c6KfSgoQzFhMk3etc",
          "scheduledActorTaskId": "c6KfSgoQzFhMk3etc"
        },
        "usageTotalUsd": 0.2,
        "defaultKeyValueStoreId": "sfAjeR4QmeJCQzTfe",
        "defaultDatasetId": "3ZojQDdFTsyE7Moy4",
        "defaultRequestQueueId": "so93g2shcDzK3pA85",
        "standby": {
          "deployment": "MULTI_TENANT_PAYING_USERS"
        }
      }
    ]
  }
}

Changes

  • 95d46c7976c0Revision changes
    • warning

      added the new MULTI_TENANT_FREE_USERS enum value to the ////// response property for the response status

    • warning

      added the new MULTI_TENANT_OWNER_PAID enum value to the ////// response property for the response status

    • warning

      added the new MULTI_TENANT_PAYING_USERS enum value to the ////// response property for the response status

    • warning

      added the new SINGLE_TENANT enum value to the ////// response property for the response status

  • ec76185eb934Revision changes
    • breaking

      the //// response's property type changed from object to no type for status

    • breaking

      removed the required property ///// from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added subschema #2 to the //// response property anyOf list for the response status