Skip to main content
POST
Create a map share

Authorizations

API-Key
string
header
required

Your API key, from More → API & Integrations in the dashboard, or from ht signup / ht auth login.

Body

application/json

Same fields as MapRenderRequest, plus the link lifetime.

kind
enum<string>
Available options:
places,
members,
jobs,
zones,
trips,
waypoints,
dayroute,
timeline,
heatmap,
isochrone
title
string

Title of the map or layer. Default 'Hellotracks '.

memberId
string

Member id or username (trips, waypoints, dayroute, timeline, isochrone; optional for heatmap).

member
string

Same as memberId.

placeIds

Only these places (array or comma-separated).

placeUids

Same as placeIds.

date

YYYY-MM-DD, today, yesterday, or an integer YYYYMMDD.

from

ms timestamp, or a day as YYYY-MM-DD / today / yesterday (from = start of that day, until = end of that day).

until

ms timestamp, or a day as YYYY-MM-DD / today / yesterday (from = start of that day, until = end of that day).

fromDay

YYYY-MM-DD, today, yesterday, or an integer YYYYMMDD.

untilDay

YYYY-MM-DD, today, yesterday, or an integer YYYYMMDD.

minutes

isochrone: travel minutes.

profile
string

isochrone: travel profile, for example driving.

skip

Features to skip (places).

max

Maximum features.

at

trips with stops: ms timestamp to highlight.

locations
boolean
markers
boolean

trips: start and end markers (default true).

waypoints
boolean

trips: include waypoints (default true).

stops
boolean
force
boolean

dayroute: recalculate the route.

inhouse
boolean

dayroute: in-house routing.

jobs
boolean
layers
object[]
Minimum array length: 1
expiresIn

Milliseconds, or a number with m, h or d (30m, 24h, 7d). Default 7 days, at most 30 days.

expires

Same as expiresIn; wins when both are sent.

Response

Success

data
object
required
error
null
required
meta
object
required