ApifyApiError

An ApifyApiError is thrown for successful HTTP requests that reach the API, but the API responds with an error response. Typically, those are rate limit errors and internal errors, which are automatically retried, or validation errors, which are thrown immediately, because a correction by the user is needed.

@hideconstructor

Hierarchy

• Error
  • ApifyApiError

Index

Constructors

• constructor

Properties

• attempt
• cause
• clientMethod
• httpMethod
• message
• name
• originalStack
• path
• stack
• statusCode
• type
• prepareStackTrace
• stackTraceLimit

Methods

• captureStackTrace

Constructors

constructor

• new ApifyApiError(response: AxiosResponse<any>, attempt: number): ApifyApiError

• Overrides Error.constructor

  Parameters

  • response: AxiosResponse<any>

  • attempt: number

  Returns ApifyApiError

Properties

attempt

attempt: number

Number of the API call attempt.

externaloptionalcause

cause?: unknown

Inherited from Error.cause

clientMethod

clientMethod: string

The invoked resource client and the method. Known issue: Sometimes it displays as unknown because it can't be parsed from a stack trace.

optionalhttpMethod

httpMethod?: string

HTTP method of the API call.

externalmessage

message: string

Inherited from Error.message

name

name: string

Overrides Error.name

originalStack

originalStack: string

Original stack trace of the exception. It is replaced by a more informative stack with API call information.

optionalpath

path?: string

Full path of the API endpoint (URL excluding origin).

externaloptionalstack

stack?: string

Inherited from Error.stack

statusCode

statusCode: number

HTTP status code of the error.

optionaltype

type?: string

The type of the error, as returned by the API.

staticexternaloptionalprepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Inherited from Error.prepareStackTrace

Type declaration

• • (err: Error, stackTraces: CallSite[]): any

  • Optional override for formatting stack traces

    @see

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    ---

    Parameters

    • err: Error

    • stackTraces: CallSite[]

    Returns any

staticexternalstackTraceLimit

stackTraceLimit: number

Inherited from Error.stackTraceLimit

Methods

staticexternalcaptureStackTrace

• captureStackTrace(targetObject: object, constructorOpt?: Function): void

• Inherited from Error.captureStackTrace

  Create .stack property on a target object

  ---

  Parameters

  • externaltargetObject: object

  • externaloptionalconstructorOpt: Function

  Returns void