---
updatedAt: 2025-12-25T23:22:01.000Z
agentTools:
  projectIndex: https://integrate.route4me.com/llms.txt
---

# Get Location Heatmap

Get a heat map of the locations.

# OpenAPI definition

```json
{
  "openapi": "3.0.2",
  "info": {
    "version": "5.0-oas3",
    "title": "Route4Me Address Book API",
    "description": "Package for the Address Book API",
    "contact": {
      "name": "Route4Me",
      "url": "docs.route4me.com",
      "email": "support@route4me.com"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    }
  },
  "servers": [
    {
      "description": "Prod",
      "url": "https://wh.route4me.com/modules/api/v5.0/address-book"
    }
  ],
  "security": [
    {
      "APIKeyQueryParam": []
    },
    {
      "BearerAuth": []
    }
  ],
  "paths": {
    "/locations/heatmap": {
      "post": {
        "tags": [
          "Locations"
        ],
        "summary": "Get a heat map of the locations",
        "description": "Get a heat map of the locations",
        "operationId": "3b0baa954d42b236df6af3ec6a178854",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/CombinedRequest"
                  },
                  {
                    "$ref": "#/components/schemas/HeatmapRequest"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LocationHeatmapCollection"
                }
              }
            }
          },
          "406": {
            "description": "Validation Exception.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error406"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "APIKeyQueryParam": {
        "type": "apiKey",
        "in": "query",
        "name": "api_key"
      },
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "schemas": {
      "Error406": {
        "type": "object",
        "properties": {
          "status": {
            "type": "boolean",
            "example": false
          },
          "code": {
            "type": "integer",
            "example": 406
          },
          "exit_code": {
            "type": "integer",
            "example": 1
          },
          "error": {
            "type": "string",
            "example": "The given data was invalid."
          },
          "messages": {
            "type": "object",
            "properties": {
              "validated_property": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "message"
                }
              }
            }
          },
          "validation_errors": {
            "type": "object",
            "properties": {
              "validated_property": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "message"
                }
              }
            }
          }
        }
      },
      "CombinedRequest": {
        "title": "CombinedRequest",
        "description": "Get combined list with locations data",
        "properties": {
          "filters": {
            "properties": {
              "search_query": {
                "type": "string"
              },
              "view_mode": {
                "type": "string",
                "enum": [
                  "customer_locations",
                  "telematic_snapshot",
                  "customer_snapshot"
                ]
              },
              "address_stop_type": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "address_id": {
                "type": "array",
                "items": {
                  "type": "integer"
                }
              },
              "root_member_id": {
                "type": "array",
                "items": {
                  "type": "integer"
                }
              },
              "member_id": {
                "type": "array",
                "items": {
                  "type": "integer"
                }
              },
              "external_connection_id": {
                "type": "array",
                "items": {
                  "type": "integer"
                }
              },
              "external_vendor_id": {
                "type": "array",
                "items": {
                  "type": "integer"
                }
              },
              "external_object_id": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "customer_id": {
                "type": "array",
                "items": {
                  "type": "string",
                  "format": "hex32"
                }
              },
              "assigned_to": {
                "type": "array",
                "items": {
                  "type": "integer"
                }
              },
              "address_cube": {
                "type": "array",
                "items": {
                  "type": "integer"
                },
                "maxItems": 2
              },
              "address_pieces": {
                "type": "array",
                "items": {
                  "type": "integer"
                },
                "maxItems": 2
              },
              "address_priority": {
                "type": "array",
                "items": {
                  "type": "integer"
                },
                "maxItems": 2
              },
              "address_revenue": {
                "type": "array",
                "items": {
                  "type": "integer"
                },
                "maxItems": 2
              },
              "address_weight": {
                "type": "array",
                "items": {
                  "type": "integer"
                },
                "maxItems": 2
              },
              "in_route_count": {
                "type": "array",
                "items": {
                  "type": "integer"
                },
                "maxItems": 2
              },
              "service_time": {
                "type": "array",
                "items": {
                  "type": "integer"
                },
                "maxItems": 2
              },
              "visited_count": {
                "type": "array",
                "items": {
                  "type": "integer"
                },
                "maxItems": 2
              },
              "is_depot": {
                "type": "array",
                "items": {
                  "type": "boolean"
                },
                "maxItems": 2
              },
              "is_pickup": {
                "type": "array",
                "items": {
                  "type": "boolean"
                },
                "maxItems": 2
              },
              "is_assigned": {
                "type": "array",
                "items": {
                  "type": "boolean"
                },
                "maxItems": 2
              },
              "is_external": {
                "type": "array",
                "items": {
                  "type": "boolean"
                },
                "maxItems": 2
              },
              "parent_location_id": {
                "type": "array",
                "items": {
                  "type": "integer"
                }
              },
              "location_type_id": {
                "type": "array",
                "items": {
                  "type": "string",
                  "format": "hex32"
                }
              },
              "display": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "routed",
                    "unrouted"
                  ]
                },
                "maxItems": 2
              },
              "territories": {
                "type": "array",
                "items": {
                  "type": "string",
                  "format": "hex32"
                }
              },
              "created_date": {
                "type": "array",
                "items": {
                  "type": "string",
                  "format": "Y-m-d",
                  "example": "2025-01-22"
                },
                "maxItems": 2
              },
              "routed_date": {
                "type": "array",
                "items": {
                  "type": "string",
                  "format": "Y-m-d",
                  "example": "2025-01-22"
                },
                "maxItems": 2
              },
              "visited_date": {
                "type": "array",
                "items": {
                  "type": "string",
                  "format": "Y-m-d",
                  "example": "2025-01-22"
                },
                "maxItems": 2
              },
              "bounding_box": {
                "properties": {
                  "top": {
                    "type": "number"
                  },
                  "left": {
                    "type": "number"
                  },
                  "bottom": {
                    "type": "number"
                  },
                  "right": {
                    "type": "number"
                  }
                },
                "type": "object"
              },
              "selected_areas": {
                "type": "array",
                "items": {
                  "properties": {
                    "type": {
                      "type": "string",
                      "enum": [
                        "Point",
                        "MultiPoint",
                        "LineString",
                        "MultiLineString",
                        "Polygon",
                        "MultiPolygon",
                        "Circle"
                      ]
                    },
                    "coordinates": {
                      "type": "array",
                      "items": {
                        "type": "number"
                      }
                    }
                  },
                  "type": "object"
                }
              },
              "excluded_ids": {
                "type": "array",
                "items": {
                  "type": "integer"
                }
              },
              "keywords": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "type": "object",
            "nullable": true
          },
          "order_by": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": "[[\"field_name\", \"direction\"]]",
            "nullable": true
          },
          "page": {
            "type": "integer",
            "minimum": 1,
            "nullable": true
          },
          "per_page": {
            "type": "integer",
            "maximum": 500,
            "minimum": 1,
            "nullable": true
          },
          "group_by": {
            "type": "string",
            "enum": [
              "customer"
            ],
            "nullable": true
          },
          "selected_fields": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          }
        },
        "type": "object"
      },
      "HeatmapRequest": {
        "title": "HeatmapRequest",
        "description": "Get a heat map of the locations",
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/CombinedRequest"
          },
          {
            "properties": {
              "zoom": {
                "type": "integer",
                "maximum": 22,
                "minimum": 0
              }
            },
            "type": "object"
          }
        ]
      },
      "LocationHeatmapCollection": {
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "type": "number",
                "maxItems": 3,
                "minItems": 3
              },
              "example": [
                40.09999997,
                -80.10000005,
                125
              ]
            }
          },
          "fields": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "lat",
              "lng",
              "intensity"
            ]
          }
        },
        "type": "object"
      }
    }
  }
}
```