Hypertext Transfer Protocol (HTTP) service, including: HTTP, HTTPS, and HTTP over TLS.
Fields
| Field Name | Description |
|---|---|
status - String!
|
HTTP code returned by http server as a human friendly string e.g. "200 OK". |
statusCode - Int!
|
HTTP code returned by http server e.g. 200. |
proto - String!
|
HTTP protocol string returned by the http server e.g. "HTTP/1.0" |
protoMajor - Int!
|
HTTP protocol major version number e.g. 1. |
protoMinor - Int!
|
HTTP protocol major version number e.g. 0. |
header - [HttpHeader!]
|
HTTP headers included in the response from the http server. |
contentLength - Int!
|
Value of Http Content-Length header returned by server. |
responseBodyLength - Int!
|
Length in bytes of the response from the http server. |
responseBodyLengthExceeded - Boolean!
|
True if the response body length is greater than the maximum allowed by the system. |
probeDuration - DurationMs!
|
Duration of the http probe operation. |
renderDuration - DurationMs!
|
Duration to render the HTTP response in a headless browser. |
title - String!
|
HTML title returned in response from http server if available. |
keywords - [String!]
|
Text excluding scripts found in the rendered document split into an array of words. |
responseBodyUrl - String
|
A short-lived presigned URL that downloads a file containing the raw (pre-render) HTTP response body directly from object storage (no proxy through the API), if available. The URL is an unauthenticated, time-limited bearer link: anyone holding it can fetch the body until it expires, so treat it as a credential and do not persist or share it. The body is captured only for 200 responses. When the response exceeded the server's configured maximum response-body size the stored bytes are a truncated prefix (the first N bytes) rather than the whole body, and responseBodyLengthExceeded is true. |
responseBody - String
|
The raw (pre-render) HTTP response body decoded as a UTF-8 string, truncated to the smaller of limit and the server's configured maximum response-body size. Returns null when no response body is available or when the truncated byte range is not valid UTF-8. Note: truncation may split a multibyte rune at the boundary, in which case the result is null — request a slightly smaller limit if that matters. Unlike renderedPageSource (the post-JavaScript DOM), these are the exact bytes the server returned — or, when responseBodyLengthExceeded is true, the first N bytes of them (the origin response was itself truncated to the server's maximum before storage). Prefer responseBodyUrl for large bodies; use this field to embed the body inline in a single response — for example to hand it to a rule query for AI analysis — without a second round-trip to object storage. |
|
Arguments
Maximum number of bytes to decode. Values <= 0 or above the server's configured maximum response-body size are clamped to that maximum. |
|
screenshotUrl - String
|
A short-lived presigned URL that downloads a screenshot of the rendered http response directly from object storage (no proxy through the API), if available. The URL is an unauthenticated, time-limited bearer link: anyone holding it can fetch the screenshot until it expires, so treat it as a credential and do not persist or share it. |
screenshot - Binary
|
The screenshot of the rendered http response returned inline as raw PNG bytes (a base64 Binary scalar), if available. Null when no screenshot was captured. Prefer screenshotUrl for large images or when streaming directly to a browser; use this field to embed the image inline in a single response without a second round-trip to object storage. |
renderedPageSourceUrl - String
|
A short-lived presigned URL that downloads a file containing the HTML source of the http response directly from object storage (no proxy through the API), if available. The URL is an unauthenticated, time-limited bearer link: anyone holding it can fetch the source until it expires, so treat it as a credential and do not persist or share it. |
renderedPageSource - String
|
The rendered (post-JavaScript) HTML source of the http response decoded as a UTF-8 string, truncated to the smaller of limit and the server's configured maximum rendered-page size. Returns null when no rendered page is available or when the truncated byte range is not valid UTF-8. Note: truncation may split a multibyte rune at the boundary, in which case the result is null — request a slightly smaller limit if that matters. Prefer renderedPageSourceUrl for large pages; use this field to embed the source inline without a second round-trip to object storage. |
|
Arguments
Maximum number of bytes to decode. Values <= 0 or above the server's configured maximum rendered-page size are clamped to that maximum. |
|
tls - TLS
|
Optional details about the SSL / TLS connection if https was used. |
Used by
ServiceReportunion: The service specific data structure describing details of the specific type of service.
Example
Example
{
"status": "xyz789",
"statusCode": 123,
"proto": "abc123",
"protoMajor": 123,
"protoMinor": 123,
"header": [HttpHeader],
"contentLength": 123,
"responseBodyLength": 123,
"responseBodyLengthExceeded": false,
"probeDuration": "600",
"renderDuration": "600",
"title": "abc123",
"keywords": ["abc123"],
"responseBodyUrl": "abc123",
"responseBody": "abc123",
"screenshotUrl": "xyz789",
"screenshot": Binary,
"renderedPageSourceUrl": "xyz789",
"renderedPageSource": "xyz789",
"tls": TLS
}