Skip to main content

Get head

GET 
/v2/request-queues/:queueId/head

Returns given number of first requests from the queue.

The response contains the hadMultipleClients boolean field which indicates that the queue was accessed by more than one client (with unique or empty clientKey). This field is used by Apify SDK to determine whether the local cache is consistent with the request queue, and thus optimize performance of certain operations.

Request

Path Parameters

    queueId string required

    Queue ID or username~queue-name.


    Example: WkzbQMuFYuamGv3YF

Query Parameters

    limit double

    How many items from queue should be returned.


    Example: 100
    clientKey string

    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.


    Example: client-abc

Status 200

Response Headers
    {
      "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"
          }
        ]
      }
    }