Skip to main content
Version: Next

RequestResource

Complete schema for a request in the queue.

Represents a URL to be crawled along with its metadata, retry information, and custom data.

Hierarchy

Index

Properties

Properties

optionalinheritederrorMessages

errorMessages?: null | string[]
null

Error messages recorded from failed processing attempts.

optionalinheritedhandledAt

handledAt?: null | Date

Format: date-time

2019-06-16T10:23:31.607Z

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

optionalinheritedheaders

headers?: null | Record<string, unknown>
null

HTTP headers sent with the request.

inheritedid

id: string

optionalinheritedloadedUrl

loadedUrl?: null | string
https://apify.com/jobs

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

optionalinheritedlockByClient

lockByClient?: string
my-client-key

Key of the client that last locked the request. It is set when the request is locked and removed only by an explicit unlock or by an update of the request, so it can still be present after the lock has expired.

optionalinheritedlockExpiresAt

lockExpiresAt?: Date

The timestamp when the lock on this request expires. Only present while the request is locked.

optionalinheritedmethod

method?: GET | HEAD | POST | PUT | DELETE | CONNECT | OPTIONS | TRACE | PATCH

optionalinheritednoRetry

noRetry?: null | boolean
false

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

optionalinheritedpayload

payload?: null | string | Record<string, unknown>
null

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

optionalinheritedretryCount

retryCount?: number

inheriteduniqueKey

uniqueKey: string

inheritedurl

url: string

optionalinheriteduserData

userData?: {}

Type declaration

    Page Options