v3

latestOpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB
Default request queue

Get default request queue head

Returns the given number of first requests from the default request queue of the Actor run.

This endpoint is a shortcut for getting the run's defaultRequestQueueId and then using the Get head endpoint.

get/v2/actor-runs/{runId}/request-queue/head

Path parameters

runIdstring required
Example:3KH8gEpp4d8uQSe8T

Actor run ID.

Query parameters

limitnumber double
Example:100

How many items from queue should be returned.

clientKeystring
Example:client-abc

A unique identifier of the client accessing the request queue. It must be a string between 1 and 32 characters long. This identifier is used to determine whether the queue was accessed by multiple clients. If clientKey is not provided, the system considers this API call to come from a new client. For details, see the hadMultipleClients field returned by the Get head operation.

Response

Example response

{
  "data": {
    "limit": 1000,
    "queueModifiedAt": "2018-03-14T23:00:00.000Z",
    "hadMultipleClients": false,
    "items": [
      {
        "id": "8OamqXBCpPHxyH9",
        "retryCount": 0,
        "uniqueKey": "http://example.com",
        "url": "http://example.com",
        "method": "GET"
      },
      {
        "id": "ZJAoqlRijenMQIn",
        "retryCount": 0,
        "uniqueKey": "http://example.com/a/b",
        "url": "http://example.com/a/b",
        "method": "GET"
      },
      {
        "id": "hAhkwyk5oOBHKQC",
        "retryCount": 1,
        "uniqueKey": "http://example.com/c/d",
        "url": "http://example.com/c/d",
        "method": "GET"
      }
    ]
  }
}