Skip to main content

Analytics API Reference

API docs by Redocly

Planet Analytics (v1)

Download OpenAPI specification:Download

Planet Analytics leverages computer vision to transform our imagery into analytic feeds that detect and classify objects, identify geographic features, and monitor change over time across the globe.

The Analytics API provides operations for working with feeds, subscriptions, and collections of results.

Feeds

A feed represents an analytic derived from Planet imagery. For example, a roads feed represents roads detected on monthly Planet mosaics and a vessels feed represents ships detected on daily Planet imagery.

List feeds

Get a list of available feeds. Feeds are returned in descending creation order (most recently created first).

Authorizations:
JWTAPIKeyBasic
query Parameters
before
string

When paginating, provide the identifier for last feed on previous page.

limit
integer <uint64> [ 1 .. 10000 ]
Default: 250

Upper limit for the number of feeds returned.

Responses

Response samples

Content type
{
  • "data": [
    ],
  • "links": [
    ],
  • "more": true
}

Get feed

Get details for a feed.

Authorizations:
JWTAPIKeyBasic
path Parameters
id
required
string

Feed ID.

Responses

Response samples

Content type
{
  • "created": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "links": [
    ],
  • "source": [
    ],
  • "target": {
    },
  • "title": "string",
  • "updated": "2019-08-24T14:15:22Z"
}

Subscriptions

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 twelve months in San Francisco, California.

List subscriptions

Get a list of all subscriptions. Subscriptions are returned in descending creation order (most recently created first).

Authorizations:
JWTAPIKeyBasic
query Parameters
feedID
string
before
string

When paginating, provide the identifier for last subscription on previous page.

limit
integer <uint64> [ 1 .. 10000 ]
Default: 250

Upper limit for the number of subscriptions returned.

Responses

Response samples

Content type
{
  • "data": [
    ],
  • "links": [
    ],
  • "more": true
}

Get subscription

Get subscription info.

Authorizations:
JWTAPIKeyBasic
path Parameters
id
required
string

Subscription ID.

Responses

Response samples

Content type
{
  • "created": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "feedID": "string",
  • "geometry": {
    },
  • "id": "string",
  • "links": [
    ],
  • "sourceUpdated": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "title": "string",
  • "updated": "2019-08-24T14:15:22Z"
}

Results

When new imagery is published in a user's subscription, Planet’s computer vision operations process the imagery, and its output is added to the collection of results associated with the subscription. For example, if a user has a subscription for the vessel feed, newly published daily imagery within that subscription AOI will be processed and new ship detections will be added to the subscription results. For raster-based output like building detections, results representing the footprint and linking to the raster data are added to the collection of subscription results.

Get collection

Get metadata for a single results collection.

Authorizations:
JWTAPIKeyBasic
path Parameters
id
required
string

Subscription ID.

Responses

Response samples

Content type
{
  • "created": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "extent": {
    },
  • "id": "string",
  • "links": [
    ],
  • "title": "string"
}

List results

Paginate through results for a subscription. Results are returned in descending creation order. Result IDs act as cursors when paginating backwards or forwards. To get older pages of results, use the before query parameter with the id of the oldest (last) result in a page of results. When returning to the API to query for newly created results, use the after query parameter with the id of the newest (first) result in a page. Results have a created field that can be stored and used later for sorting to determine the oldest or newest result from a previous query.

Authorizations:
JWTAPIKeyBasic
path Parameters
subscriptionID
required
string

Subscription ID.

query Parameters
limit
integer <uint64> [ 1 .. 10000 ]
Default: 250

Upper limit for the number of results returned.

bbox
Array of numbers = 4 items

Only return results that intersect the provided bounding box. Bounding box values are min longitude, min latitude, max longitude, and max latitude (e.g. -100,-50,100,50).

time
string

Alias for datetime. Please use the datetime parameter instead. This property is deprecated and will be removed in a future release.

datetime
string

Only return results that were observed in the given interval or instant. The time can be a closed interval (e.g. 2019-01-01T00:00:00.00Z/2019-02-01T00:00:00.00Z for the month of January), an open interval (e.g. 2019-01-01T00:00:00.00Z/.. for all results in January or later and ../2019-01-01T00:00:00.00Z for all results before January), or an instant (e.g. 2019-01-01T00:00:00.00Z). Start times for intervals are inclusive, and end times are exclusive.

before
string

Get results published before the item with the provided ID.

after
string

Get results published after the item with the provided ID.

Responses

Response samples

Content type
application/geo+json
{
  • "features": [
    ],
  • "links": [
    ],
  • "type": "FeatureCollection"
}

Get result

Get a single result.

Authorizations:
JWTAPIKeyBasic
path Parameters
subscriptionID
required
string

Subscription ID.

resultID
required
string

Result ID.

Responses

Response samples

Content type
application/geo+json
{
  • "created": "2019-08-24T14:15:22Z",
  • "geometry": {
    },
  • "id": "string",
  • "links": [
    ],
  • "properties": {
    },
  • "type": "Feature"
}

OGC

Operations specific to the OGC API - Features interface.

Service root

Get links to resources provided by the service.

Authorizations:
JWTAPIKeyBasic

Responses

Response samples

Content type
{
  • "links": [
    ]
}

Conformance details

Get details about OGC API - Features conformance.

Authorizations:
JWTAPIKeyBasic

Responses

Response samples

Content type
{
  • "conformsTo": [
    ]
}
Last updated on