/media/recordedImage.jpeg

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 recording is available at the given timestamp param. If no recording is available at the given timestamp param a 404 NOT FOUND 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 API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The ID of the device that generates the media.

string

Token provided by X-Een-NextToken or X-Een-PrevToken header of a previous image call. If this parameter is present no other parameters are required, and any sent will be ignored

string
enum

The stream type of the device used to generate the media.

Allowed:
date-time

Return first image with timestamp less then.

date-time

Return first image with timestamp less or equal.

date-time

Return image at this exact timestamp.

date-time

Return first image with timestamp greater or equal.

date-time

Return first image with timestamp greater then.

overlayId__in
array of strings
length ≥ 1

What info will be included in the returned overlay. At least one id must be provided if an overlay is requested for the include parameter.

overlayId__in
integer
32 to 7680

The target width of the image to be returned. If not specified while targetHeight is, we scale the width to keep the aspect ratio of the image.

integer
32 to 4320

The target height of the image to be returned. If not specified while targetWidth is, we scale the height to keep the aspect ratio of the image.

include
array of strings

Extra options that can be included in the api response:

  • overlayEmbedded: draws the overlay on top of the source image resulting in a single jpeg
  • overlaySvgHeader: adds the X-Een-OverlaySvg header containing the overlays as a SVG image
include
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
image/jpeg
application/json