Queue provider-backed mobility analysis: routing, reachability and isochrones, nearest, travel-time metrics, or map-matching.
View input schema
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"input": {
"type": "object",
"properties": {
"mode": {
"default": "preview",
"type": "string",
"enum": [
"preview",
"materialize"
]
},
"profile": {
"default": "driving",
"type": "string",
"enum": [
"driving",
"walking",
"cycling",
"truck"
]
},
"operation": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "route"
},
"locations": {
"minItems": 2,
"maxItems": 25,
"type": "array",
"items": {
"type": "object",
"properties": {
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
},
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"longitude",
"latitude"
],
"additionalProperties": false
}
},
"alternatives": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 3
}
},
"required": [
"type",
"locations"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "reachability"
},
"origins": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "coordinates"
},
"values": {
"minItems": 1,
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
},
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"longitude",
"latitude"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"values"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "resource"
},
"resource": {
"type": "string",
"pattern": "^(source|derived):[0-9a-f-]{36}$"
},
"idField": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"labelField": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"maxPoints": {
"default": 500,
"type": "integer",
"minimum": 1,
"maximum": 500
}
},
"required": [
"type",
"resource"
],
"additionalProperties": false
}
]
},
"output": {
"default": "contours",
"type": "string",
"enum": [
"contours",
"h3"
]
},
"contourMinutes": {
"default": [
15,
30
],
"minItems": 1,
"maxItems": 4,
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 240
}
},
"extent": {
"type": "array",
"prefixItems": [
{
"type": "number",
"minimum": -180,
"maximum": 180
},
{
"type": "number",
"minimum": -90,
"maximum": 90
},
{
"type": "number",
"minimum": -180,
"maximum": 180
},
{
"type": "number",
"minimum": -90,
"maximum": 90
}
]
},
"detail": {
"default": "auto",
"type": "string",
"enum": [
"auto",
"coarse",
"standard",
"detailed"
]
},
"h3Resolution": {
"type": "integer",
"minimum": 4,
"maximum": 10
}
},
"required": [
"type",
"origins"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "nearest"
},
"origins": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "coordinates"
},
"values": {
"minItems": 1,
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
},
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"longitude",
"latitude"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"values"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "resource"
},
"resource": {
"type": "string",
"pattern": "^(source|derived):[0-9a-f-]{36}$"
},
"idField": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"labelField": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"maxPoints": {
"default": 500,
"type": "integer",
"minimum": 1,
"maximum": 500
}
},
"required": [
"type",
"resource"
],
"additionalProperties": false
}
]
},
"destinations": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "coordinates"
},
"values": {
"minItems": 1,
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
},
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"longitude",
"latitude"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"values"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "resource"
},
"resource": {
"type": "string",
"pattern": "^(source|derived):[0-9a-f-]{36}$"
},
"idField": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"labelField": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"maxPoints": {
"default": 500,
"type": "integer",
"minimum": 1,
"maximum": 500
}
},
"required": [
"type",
"resource"
],
"additionalProperties": false
}
]
}
},
"required": [
"type",
"origins",
"destinations"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "travelMetrics"
},
"sources": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "coordinates"
},
"values": {
"minItems": 1,
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
},
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"longitude",
"latitude"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"values"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "resource"
},
"resource": {
"type": "string",
"pattern": "^(source|derived):[0-9a-f-]{36}$"
},
"idField": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"labelField": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"maxPoints": {
"default": 500,
"type": "integer",
"minimum": 1,
"maximum": 500
}
},
"required": [
"type",
"resource"
],
"additionalProperties": false
}
]
},
"targets": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "coordinates"
},
"values": {
"minItems": 1,
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
},
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"longitude",
"latitude"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"values"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "resource"
},
"resource": {
"type": "string",
"pattern": "^(source|derived):[0-9a-f-]{36}$"
},
"idField": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"labelField": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"maxPoints": {
"default": 500,
"type": "integer",
"minimum": 1,
"maximum": 500
}
},
"required": [
"type",
"resource"
],
"additionalProperties": false
}
]
}
},
"required": [
"type",
"sources",
"targets"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "mapMatch"
},
"trace": {
"minItems": 2,
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
},
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
},
"required": [
"longitude",
"latitude"
],
"additionalProperties": false
}
}
},
"required": [
"type",
"trace"
],
"additionalProperties": false
}
]
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"attachToProject": {
"default": true,
"type": "boolean"
}
},
"required": [
"operation"
],
"additionalProperties": false
}
},
"required": [
"projectId",
"input"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}