Get an EdgeWorker report

get

https://{hostname}/edgeworkers/v1/reports/{reportId}

View a report for a set of EdgeWorkers. Note that reports 2 and 4 have been deprecated.

Path Params

reportId

integer

required

Unique identifier of an EdgeWorker report.

Query Params

start

date-time

required

ISO 8601 timestamp indicating the start time of the EdgeWorker report.

end

date-time

required

ISO 8601 timestamp indicating the end time of the EdgeWorker report. If not specified, the end time defaults to the current time.

edgeWorker

string

required

Filter by EdgeWorker IDs such as 42 or more specific versions such as 42-1.0. You can repeat the parameter, such as ?edgeWorker=42&edgeWorker=21-1.0&edgeWorker=21-2.3.

status

string

enum

required

Enum Filter by the EdgeWorker status, either success, genericError, unknownEdgeWorkerId, runtimeError, executionError, timeoutError, resourceLimitHit, cpuTimeoutError, wallTimeoutError, initCpuTimeoutError, initWallTimeoutError, subworkerNotEnabled, or subworkersLimitHit.

Note that the report whose ID is 7 (for sub-requests) can't be filtered by status.

eventHandler

string

enum

Enum Filter EdgeWorkers by the event that triggers them, either onClientRequest, onOriginRequest, onOriginResponse, onClientResponse, responseProvider, or onBotSegmentAvailable.

Allowed:

continueOnErrorOnly

boolean

When enabled, limits results to EdgeWorker executions that attempted to apply continue on error.

network

string

enum

Enum Filter by the network on which the EdgeWorker was invoked, either STAGING or PRODUCTION.

Allowed:

revisionId

string

Filter by the revision ID of the EdgeWorker.

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Response

200This section describes attributes of an EdgeWorker report.