View Export Status

The Retrieve Vector API is used to retrieve an item from the vector index by ID.

Fields in the response

  • request_id: The client-provided string from the original tile generation request.

  • state: One of "submitted", "running", or "finished".

  • start_time: The ISO-8601-formatted string representing the date the tile generation process began.

  • end_time: The ISO-8601-formatted string representing the date the tile generation process completed.

  • success: A boolean reporting whether or not the tile generation process was successful.

  • duration_seconds: The number of seconds passed from start to finish for the entire process.

  • duration_str: The hour:minute:seconds string representation of the duration.

  • query_duration_seconds: The number of seconds passed from the start of the data-retrieval phase to the end of the data-retrieval phase.

  • query_duration_str: The hour:minute:seconds string representation of the data-retrieval duration.

  • vectors_retrieved: The number of features retrieved from the vector indexes.

  • retrieval_errors: Any errors reported by the data retrieval process.

  • tiler: Provides the output of the tiling process and whether or not it completed successfully. Note, for large data sets, this output field can be extremely long.

  • tiler_duration_seconds: The number of seconds passed from the start of the tiling process to the end of the tiling process.

  • tiler_duration_str: The hour:minute:seconds string representation of the tiler duration.

  • upload_duration_seconds: The number of seconds passed from the start of the tile upload process to the end of the tile upload process.

  • upload_duration_str: The hour:minute:seconds string representation of the upload duration.

  • upload_errors: Any errors reported by the tile upload process.

  • tileset_url: The URL template which can be used to retrieve tiles in JS libraries like mapbox-gl and Leaflet.

  • shapefile_duration_seconds: The number of seconds passed from the start of the tile upload process to the end of the shapefile generation process.

  • shapefile_duration_str: The hour:minute:seconds string representation of the shapefile generation duration.

  • shapefile_errors: Any errors reported by the shapefile generation process.

  • shapefile_files: A list of files generated by the shapefile generation process.

Language
Authentication
Header
Click Try It! to start a request and see the response here!