Storage/Request queues/Requests locks

Get request queue head

Changed on

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.

get/v2/request-queues/{queueId}/head

Request

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

Path parameters

queueIdstring required
Example:WkzbQMuFYuamGv3YF

Queue ID or username~queue-name.

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 request queue head endpoint.

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"
      }
    ]
  }
}

Changes

    • 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 the optional property / to the response with the status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status