Analytics Overview
Planet Analytics leverages computer vision to transform imagery into Analytic Feeds that detect and classify objects, identify geographic features, and understand change over time across the globe. These docs are intended to help users access the Analytic Feeds and leverage them to build applications and solutions.
The Analytics API is a RESTful API interface to provide programmatic access to Planet Analytic Feeds. It enables search and retrieval of analytic results within the user's subscription.
The Analytic Feeds Viewer is an excellent example of what can be built on the Analytics API. Documentation for the Analytic Feeds Viewer can be found here.
Analytics API components
Feeds and Subscriptions
Learn how to list feeds and subscriptions in the Analytics API.
Querying Results
Learn how to query subscription results in the Analytics API.
API Reference
OpenAPI specification for REST API
Feeds
An Analytic Feed represents the blueprint for what model and what processing needs to take place to create analytics output derived from Planet imagery. Each feed represents an analytic capability uniquely configured to optimize performance and quality, and each feed has unique types of outputs. For example, a Monthly Road Detection Feed represents roads detected on monthly Planet Basemaps and outputs raster "segmentation mask" data. Many different types of feeds are currently available through the Planet Analytics API, and new feeds are released continuously.
Subscriptions
Note: Analytic subscriptions are distinct from data subscriptions in the Subscriptions API.
Users have subscriptions to feeds in a specific Area of Interest (AOI) and Time Interval of Interest (TOI). For example, a subscription could be Road Detection over 12 months in San Francisco, California. Users can get a list of their subscriptions from the Analytics API.
Results
When new imagery is published in a user's subscription, Planet's computer vision models process the imagery and its output is added to a collection of results associated with the subscription. For example, if a user has a subscription for the Vessel Detection Feed, newly published daily imagery within that subscription AOI will be processed, and new vessel detections will be added to the subscription results. Feature Collection results are ordered in the API by creation date, with most recent collections listed first.
Each result contains reference links to the source imagery used to derive the result. This enables users to download or reference the imagery as needed.
Multiple source imagery references will be made for Analytic Feeds that surface change over time. This lets users quickly find “before” and “after” views.
Vector Results
For vector-based results, geojson outputs are stored in Web Feature Service collections. These detections will serve as vector features. Each feature in the feature collection from the API will reference an individual instance of a detection (For example, a vessel) or change detection (For example, building construction).
Raster Results
GeoTIFF outputs containing raster results will serve as links within a feature collection. Each feature in the feature collection from the Analytics API references a mosaic quad with links to the source (input imagery for the analytic operation) and target results of the analytic operation (For example, a raster containing road or building pixels).
Available Feeds, Imagery, and Output Formats
| Feed | Source Imagery | Result Format |
|---|---|---|
| Building Detection | Mosaic | Raster |
| Road Detection | Mosaic | Raster |
| Vessel Detection | Scene | Vector |
| Plane Detection | Scene | Vector |
| Building Change Detection | Multiple Mosaics | Vector |
| Road Change Detection | Multiple Mosaics | Vector |
Web Map Tile Service
By leveraging Planet's Webmap Tile Service (WMTS), you can stream source imagery and derived raster output into ArcGIS, QGIS or any other GIS you wish to use. Enter the URL shown below into your GIS to surface a list of mosaic imagery you have access to. This includes both satellite imagery and derivative raster output (For example, road detections).
https://api.planet.com/basemaps/v1/mosaics/wmts?api_key={api-key}
Our naming convention for derivative raster output is SIF-<Feed_ID>-yyyy-mm-dd. You will most likely see several that look like the following:
| Item Title | Description |
|---|---|
| Global Monthly 2020 01 Mosaic | This represents Planet's global visual mosaic product for January 2020 |
| sif-b442c53b-fc72-4bee-bab4-0b7aa318ccd9-2020-01-01 | This represents the derivative raster output for a given Feed. This one is for the Feed ID “b442c53b-fc72-4bee-bab4-0b7aa318ccd9” which is a monthly building detection feed. |
Bringing these layers into your tool of choice will enable you to compare them against each other and other public or private datasets you leverage.
Learn more about how to leverage the Planet WMTS in the tile service reference documentation.
OGC Features API
The Planet Analytics API adheres to the Open Geospatial Consortium's (OGC) Features API specification, which means you can stream vector detections into your GIS platform of choice through a Web Feature Service (WFS) integration. Select the OGC Features as the version of WFS. A GET request on the endpoint below will surface a list of Analytics Results can access.
https://api.planet.com/analytics/
API Mechanics
Pagination
The Planet Analytics API paginates responses to limit the results, making them easier to work with. The JSON response will contain 250 detections maximum by default. The first GET request will yield the first page along with links representing the location of the next page. Following the next link will return another page of results. We link the rel of next to get more results. For a more detailed guide on accessing and paginating through our Analytic Feeds, check out this jupyter notebook.
Rate Limiting
All endpoints in the Analytics API have a rate limit of 10 requests per second, per API key. More information on rate limiting can be found here.
Errors
For information on API errors, see the errors page.