Skip to content

Measure Distance

POST
/api/creative/lore/maps/{map_id}/measure

Measure distance between two points on a calibrated map.

map_id
required
Map Id
string
MeasureRequest

Two points to measure distance between.

object
x1Pct
required
X1Pct
number
<= 100
y1Pct
required
Y1Pct
number
<= 100
x2Pct
required
X2Pct
number
<= 100
y2Pct
required
Y2Pct
number
<= 100

Successful Response

MeasureResponse
object
distance
required
Distance
number
unit
required
Unit
string
pixelDistance
required
Pixeldistance
number

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object