APapify
Storage/Request queues/Requests

List requests in request queue

Changed on

Returns a list of requests. This endpoint is paginated using cursor (pagination by exclusiveStartId is deprecated) and limit parameters.

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

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

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.

exclusiveStartIdstring
Example:Ihnsp8YrvJ8102Kj

All requests up to this one (including) are skipped from the result. (Deprecated, use cursor instead.)

limitnumber double
Example:100

Number of keys to be returned. Maximum value is 10000.

cursorstring
Example:eyJyZXF1ZXN0SWQiOiI2OFRqQ2RaTDNvM2hiUU0ifQ

A cursor string for pagination, returned in the previous response as nextCursor. Use this to retrieve the next page of requests.

filterstring[]

Filter requests by their state. Possible values are locked and pending. You can combine multiple values separated by commas, which will mean the union of these filters – requests matching any of the specified states will be returned. (Not compatible with deprecated exclusiveStartId parameter.)

[
  "locked"
]

Response

Example response

{
  "data": {
    "items": [
      {
        "id": "dnjkDMKLmdlkmlkmld",
        "retryCount": 0,
        "uniqueKey": "http://example.com",
        "url": "http://example.com",
        "method": "GET",
        "loadedUrl": "http://example.com/example-1",
        "payload": null,
        "noRetry": false,
        "errorMessages": null,
        "headers": null,
        "userData": {
          "label": "DETAIL",
          "image": "https://picserver1.eu"
        },
        "handledAt": "2019-06-16T10:23:31.607Z"
      },
      {
        "id": "dnjkDMKLmdlkmlkmld",
        "retryCount": 0,
        "uniqueKey": "http://example.com",
        "url": "http://example.com",
        "method": "GET",
        "loadedUrl": "http://example.com/example-1",
        "payload": null,
        "noRetry": false,
        "errorMessages": null,
        "headers": null,
        "userData": {
          "label": "DETAIL",
          "image": "https://picserver1.eu"
        },
        "handledAt": "2019-06-16T10:23:31.607Z"
      }
    ],
    "limit": 2,
    "exclusiveStartId": "Ihnsp8YrvJ8102Kj"
  }
}

Changes

  • ec76185eb934Revision 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

    • info

      added the optional property / to the response with the status

  • e52dd2239ceeRevision changes
    • info

      added the optional property //// to the response with the status