Class SyntheticsAPITestResultData

Object containing results for your Synthetic API test.

Hierarchy

  • SyntheticsAPITestResultData

Constructors

constructor

Properties

additionalProperties? cert? eventType? failure? httpStatusCode? requestHeaders? responseBody? responseHeaders? responseSize? timings?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional cert

cert?: SyntheticsSSLCertificate

Object describing the SSL certificate used for a Synthetic test.

Optional eventType

eventType?: SyntheticsTestProcessStatus

Status of a Synthetic test.

Optional failure

failure?: SyntheticsApiTestResultFailure

The API test failure details.

Optional httpStatusCode

httpStatusCode?: number

The API test HTTP status code.

Optional requestHeaders

requestHeaders?: {
    [key: string]: any;
}

Request header object used for the API test.

Type declaration

  • [key: string]: any

Optional responseBody

responseBody?: string

Response body returned for the API test.

Optional responseHeaders

responseHeaders?: {
    [key: string]: any;
}

Response headers returned for the API test.

Type declaration

  • [key: string]: any

Optional responseSize

responseSize?: number

Global size in byte of the API test response.

Optional timings

timings?: SyntheticsTiming

Object containing all metrics and their values collected for a Synthetic API test. See the Synthetic Monitoring Metrics documentation.

Settings

Member Visibility

Theme

Generated using TypeDoc