Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Media

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.

get/media/recordedImage.jpeg

Query parameters

deviceIdstring
Example:10058b7a

The ID of the device that generates the media.

pageTokenstring
Example:cHJldlBhZ2VQbHoK

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

type'preview' | 'main'

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

timestamp__ltstring date-time
Example:2022-08-08T07:57:37.000+00:00

Return first image with timestamp less then.

timestamp__ltestring date-time
Example:2022-08-08T07:57:37.000+00:00

Return first image with timestamp less or equal.

timestampstring date-time
Example:2022-08-08T07:57:37.000+00:00

Return image at this exact timestamp.

timestamp__gtestring date-time
Example:2022-08-08T07:57:37.000+00:00

Return first image with timestamp greater or equal.

timestamp__gtstring date-time
Example:2022-08-08T07:57:37.000+00:00

Return first image with timestamp greater then.

overlayId__instring[]

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.

[
  "een.motionDetectionEvent.v1"
]
targetWidthinteger
Example:1920

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.

targetHeightinteger
Example:1080

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.

includestring[]

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

Response

OK