This endpoint retrieves an image based on a specified timestamp. You can indicate whether the image must be captured exactly at that timestamp or allow a nearest match before or after. The timestamp must be submitted in ISO 8601 format.
Each request must include one timestamp parameter and specify the desired image type — either main
or preview
. Alternatively, by submitting a pageToken
, the next/previous image from the last image is returned. In this case, none of the other parameters are used.
Be aware that the image type main
is rate-limited, and should not be used in quick succession. Additionally, it requires that a full-resolution recording is available at the given timestamp. If no recording is available, a 404 NOT FOUND
error will be returned.
If an overlay is requested in the include
parameter, then at least one overlayId must be provided as part of the overlayId__in
parameter. The list of available overlay ids can be retrieved using the GET /media/recordedImage.jpeg:listFieldValues endpoint.