Frame query
Description
Used to obtain information about frames in JSON format from the database.
URL
https://frames.enlapser.cloud/<frame_source_id>/<language>/frame_query
  • frame_source_id - the Object ID of a Frame source
  • language - a language supported by the frame source
Request method
GET
Request headers
If the frame source is not public, you must log in first to obtain a cookie and then supply that cookie with the request cookie header.

Example:
Cookie: timespace1-1=123456789_abcdefghijklmnopqrSTUVXYZ
Query parameters
All parameters are optional. Without parameters the url will return the timestamp of the latest frame.

To search for a frame between two dates, use:
  • start=<milliseconds> in UTC since the epoch
  • end=<milliseconds>
This will return the timestamp of the frame between start and end that is closest to start (inclusive). If start is specified but not end, end will default to the epoch.
Success response
On success, the server will respond with status code 200. The response body contains data in the JSON format.

If found, the response will contain the timestamp. Example:
{ "timestamp": 12345678901234 }

If not found, the response will contain found: false with an optional error message or object. Example:
{ "found": false, error: {} }
Error response
403 Forbidden
  • when the client does not have adequate permissions to the frame source or its dependencies

404 Not found
  • when the frame source does not exist
Feed