Get request

GET 
/v2/request-queues/:queueId/requests/:requestId

Returns request from queue.

Request

Path Parameters

queueId string required
Queue ID or username~queue-name.

Example: WkzbQMuFYuamGv3YF
requestId string required
Request ID.

Example: xpsmkDlspokDSmklS

Status 200

Response Headers

{
  "data": {
    "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"
  }
}

Schema

data object required
A request stored in the request queue, including its metadata and processing state.
• id string required

  A unique identifier assigned to the request.

  
  Example: dnjkDMKLmdlkmlkmld
• uniqueKey string required

  A unique key used for request de-duplication. Requests with the same unique key are considered identical.

  
  Example: GET|60d83e70|e3b0c442|https://apify.com/career
• url string<uri> required

  The URL of the request.

  
  Example: https://apify.com/career
• method string

  The HTTP method of the request.

  
  Example: GET
• retryCount integer

  The number of times this request has been retried.

  
  Example: 0
• loadedUrl string,null<uri> nullable

  The final URL that was loaded, after redirects (if any).

  
  Example: https://apify.com/jobs
• payload object | null nullable

  The request payload, typically used with POST or PUT requests.

• headers object | null nullable

  HTTP headers sent with the request.

• userData object

  Custom user data attached to the request. Can contain arbitrary fields.

  • label string | null nullable

    Optional label for categorizing the request.

    
    Example: DETAIL
  • image string,null<uri> nullable

    Optional image URL associated with the request.

    
    Example: https://picserver1.eu
  • property name* any

    Custom user data attached to the request. Can contain arbitrary fields.

• noRetry boolean | null nullable

  Indicates whether the request should not be retried if processing fails.

  
  Example: false
• errorMessages string[] nullable

  Error messages recorded from failed processing attempts.

• handledAt string,null<date-time> nullable

  The timestamp when the request was marked as handled, if applicable.

  
  Example: 2019-06-16T10:23:31.607Z

Status 400

Bad request - invalid input parameters or request body.

{
  "error": {
    "type": "invalid-input",
    "message": "Invalid input: The request body contains invalid data."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)