Skip to main content

Get Route Thumbnail

If thumbnail generation is enabled, use this command to get a route’s thumbnail. Retrieve the Route ID via the Get List of Routes (v2) command.

Thumbnail generation must be enabled on your Gateway. See System Details for more details.

Active for Version: 4.2+

Authorizations: Administrator, Operator, Observer

Requests

CODE 
GET /api/routes/[Route ID]/thumbnail
cookie: sessionID: [Session ID]

Parameters

N/A

Response

OK

Thumbnail image in JPEG format.

response.jpeg
Error
CODE 
{
    "error": {
        "type": "getRouteThumbnail",
        "message": "Failed to retrieve route thumbnail"
    }
}

Tip

Ensure Thumbnail Preview is enabled in the … > Settings screen.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close