Skip to content

Commit d7ce3a9

Browse files
docs(api-checks): document image response previews (#459)
1 parent 3f2e8dd commit d7ce3a9

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

detect/synthetic-monitoring/api-checks/configuration.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,26 @@ In almost all cases, you have access to the HTTP response for assertions. Checkl
186186
body. For larger responses, only the first 25MB is available to assertions and teardown scripts. The response body
187187
stored with the result can be truncated further to fit result-size limits.
188188

189+
### Previewing image response bodies
190+
191+
Checkly displays a preview and download option in API check results when the raw response body is 50KB or smaller
192+
and the response `Content-Type` is one of these supported raster image types:
193+
194+
- `image/png`
195+
- `image/jpeg`
196+
- `image/gif`
197+
- `image/webp`
198+
- `image/avif`
199+
- `image/apng`
200+
- `image/bmp`
201+
- `image/x-icon`
202+
- `image/vnd.microsoft.icon`
203+
204+
Checkly uses the `Content-Type` header rather than the file extension to identify images. Images larger than 50KB
205+
are truncated when stored and cannot be previewed. SVG, TIFF, other unsupported image types, and results created
206+
before image preview support cannot be previewed either. Slack alerts do not include a response body preview for
207+
supported images.
208+
189209
Additionally, if your API responds with a binary type body, i.e. a PDF or video file, we scrub the body and replace
190210
it with a short text saying that we scrubbed it. We determine the body content type by looking at the `Content-Type`
191211
response header.

0 commit comments

Comments
 (0)