Timeseries

The Timeseries endpoints are used to generate time series data for the datasets available in Climate Engine.
There are three groups of Timeseries endpoints:
/timeseries/native - The native endpoints are used to generate ‘raw’ time series data over points/polygons/features for Climate Engine datasets.
/timeseries/interannual - The interannual endpoints are used to generate time series of yearly values of the dataset variable summarized over a season.
/timeseries/regression - The regression endpoints are used to perform regression analysis of the dataset variable summarized over a season.
NOTES:
- The ‘forecasts’ endpoints are only available for forecast datasets (i.e. CFS_GRIDMET and FRET).
/timeseries/native/points
/timeseries/native/forecasts/points
/timeseries/native/polygons
/timeseries/native/forecasts/polygons
/timeseries/native/climate_engine_asset
/timeseries/native/forecasts/climate_engine_asset
/timeseries/native/custom_asset
/timeseries/native/forecasts/custom_asset
/timeseries/interannual/points
/timeseries/interannual/polygons
/timeseries/interannual/climate_engine_asset
/timeseries/interannual/custom_asset
/timeseries/regression/points
/timeseries/regression/polygons
/timeseries/regression/climate_engine_asset
/timeseries/regression/custom_asset

/timeseries/native/points

Generates timeseries of values of the dataset variable and timeperiod between start_date and end_date at a point location.
Returns: json

Resource url example:

/timeseries/native/points?dataset=GRIDMET&variable=pr&start_date=2014-01-01&end_date=2014-02-01&coordinates=[[-119.96,39.57]]

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

LANDSAT7_TOA

variable

yes

NDVI

start_date

yes

2019-01-01

end_date

yes

2019-12-31

coordinates

yes

List of point coordinates

[[-119.96,39.57]]

buffers

no

List of integer buffers (meters) to be applied to each geometry

[400]

area_reducer

yes

Statistic over region

mean

mean, median, min, max

export_path

no

Export CSV results to a Google cloud storage bucket (must have correct permissions)

climate-engine-public/my_csv_file.csv

export_format

no

File format of export

json

csv, json

/timeseries/native/forecasts/points

Generates timeseries of forecast values of the dataset variable and timeperiod between start_date and end_date at a point location.
Returns: json

Resource url example:

/timeseries/native/forecasts/points?dataset=CFS_GRIDMET&variable=pr&start_day=day01&end_day=day28&coordinates=[[-119.96,39.57]]

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

CFS_GRIDMET

CFS_GRIDMET

variable

yes

pet, pr, tmmn, tmmx

pr

model

yes

ens01 to en<xx> for individual models (see documentation), ens_min, ens_max, ens_mean, ens_median

ens_mean

ens_max

start_day

yes

day01 to day 28, start_day <= end_day

day01

day02

end_day

yes

day01 to day28, end_day >= start_day

day28

day15

coordinates

yes

List of point coordinates

[[-119.96,39.57]]

buffers

no

List of integer buffers (meters) to be applied to each geometry

[400]

area_reducer

yes

Statistic over region

mean

mean, median, min, max

export_path

no

Export CSV results to a Google cloud storage bucket (must have correct permissions)

climate-engine-public/my_csv_file.csv

export_format

no

File format of export

json

csv, json

/timeseries/native/polygons

Generates timeseries of values of the dataset variable and timeperiod between start_date and end_date for a polygon.
The values are averaged over the pixels lying within the polygon.
Returns: json

Resource url example:

/timeseries/native/polygons?dataset=LANDSAT7_TOA&variable=NDVI&start_date=2014-01-01&end_date=2018-12-30&coordinates=[[[-121.61,38.78],[-121.52,38.78],[-121.52,38.83],[-121.61,38.83],[-121.61,38.78]]]

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

LANDSAT7_TOA

variable

yes

NDVI

start_date

yes

2019-01-01

end_date

yes

2019-12-31

coordinates

yes

List of polygon coordinates

[[[-121.61,38.78], [-121.52,38.78],[-121.52,38.83],[-121.61,38.83],[-121.61,38.78]]]

buffers

no

List of integer buffers (meters) to be applied to each geometry

[400]

area_reducer

yes

Statistic over region

mean

mean, median, min, max

export_path

no

Export CSV results to a Google cloud storage bucket (must have correct permissions)

climate-engine-public/my_csv_file.csv

export_format

no

File format of export

json

csv, json

/timeseries/native/forecasts/polygons

Generates timeseries of forecast values of the dataset variable and timeperiod between start_date and end_date for a polygon.
The values are averaged over the pixels lying within the polygon.
Returns: json

Resource url example:

/timeseries/native/forecasts/polygons?dataset=CFS_GRIDMET&variable=tmmx&start_day=day01&end_day=day28&coordinates=[[[-121.61,38.78],[-121.52,38.78],[-121.52,38.83],[-121.61,38.83],[-121.61,38.78]]]

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

CFS_GRIDMET

CFS_GRIDMET

variable

yes

pet, pr, tmmn, tmmx

tmmx

model

yes

ens01 to en<xx> for individual models (see documentation), ens_min, ens_max, ens_mean, ens_median

ens_mean

ens_max

start_day

yes

day01 to day 28, start_day <= end_day

day01

day02

end_day

yes

day01 to day28, end_day >= start_day

day28

day15

coordinates

yes

List of polygon coordinates

[[[-121.61,38.78], [-121.52,38.78],[-121.52,38.83],[-121.61,38.83],[-121.61,38.78]]]

buffers

no

List of integer buffers (meters) to be applied to each geometry

[400]

area_reducer

yes

Statistic over region

mean

mean, median, min, max

export_path

no

Export CSV results to a Google cloud storage bucket (must have correct permissions)

climate-engine-public/my_csv_file.csv

export_format

no

File format of export

json

csv, json

/timeseries/native/climate_engine_asset

Generates timeseries of values of the dataset variable and time period between start_date and end_date for the features of a Climate Engine feature collection asset.
The values are averaged over the pixels lying within each feature of the feature collection.
For a list of available assets see the Climate Engine Assets section.
Returns: json

Resource url example:

/timeseries/native/climate_engine_asset?dataset=LANDSAT7_TOA&variable=NDVI&start_date=2014-01-01&end_date=2018-12-30&region=counties&sub_choices= ["ME - Aroostook"]

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

LANDSAT7_TOA

variable

yes

NDVI

start_date

yes

2019-01-01

end_date

yes

2019-12-31

region

yes

Type of feature collection

counties

sub_choices

no

List of features to use in analysis, must be strings

[“ME - Aroostook”]

area_reducer

yes

Statistic over region

mean

mean, median, min, max

export_path

no

Export CSV results to a Google cloud storage bucket (must have correct permissions)

climate-engine-public/my_csv_file.csv

export_format

no

File format of export

json

csv, json

/timeseries/native/forecasts/climate_engine_asset

Generates timeseries of forecast values of the dataset variable and timeperiod between start_date and end_date for the features of a Climate Engine feature collection asset.
The values are averaged over the pixels lying within each feature of the feature collection.
For a list of available assets see the Climate Engine Assets section.
Returns: json

Resource url example:

/timeseries/native/forecasts/climate_engine_asset?dataset=CFS_GRIDMET&variable=tmmn&start_day=day01&end_day=day28&region=counties&sub_choices= ["ME - Aroostook"]

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

CFS_GRIDMET

CFS_GRIDMET

variable

yes

pet, pr, tmmn, tmmx

tmmn

model

yes

ens01 to en<xx> for individual models (see documentation), ens_min, ens_max, ens_mean, ens_median

ens_mean

ens_max

start_day

yes

day01 to day 28, start_day <= end_day

day01

day02

end_day

yes

day01 to day28, end_day >= start_day

day28

day15

region

yes

Type of feature collection

counties

sub_choices

no

List of features to use in analysis, must be strings

[“ME - Aroostook”]

area_reducer

yes

Statistic over region

mean

mean, median, min, max

export_path

no

Export CSV results to a Google cloud storage bucket (must have correct permissions)

climate-engine-public/my_csv_file.csv

export_format

no

File format of export

json

csv, json

/timeseries/native/custom_asset

Generates timeseries of values of the dataset variable and timeperiod between start_date and end_date for the features of a custom feature collection asset.
The values are averaged over the pixels lying within each feature of the feature collection.
Permissions on custom asset must be such that it is readable by anyone.
Returns: json

Resource url example:

/timeseries/native/custom_asset?dataset=LANDSAT7_TOA&variable=NDVI&start_date=2014-01-01&end_date=2014-02-01&asset_id=WCMC/WDPA/current/points&sub_choices= ["Golden Gate"]&filter_by=NAME

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

LANDSAT7_TOA

variable

yes

NDVI

start_date

yes

2019-01-01

end_date

yes

2019-12-31

asset_id

yes

Path to Earth Engine asset

WCMC/WDPA/current/points

sub_choices

no

List of features to use in analysis, must be strings

[“Golden Gate”]

filter_by

no

Property name to filter sub-choices

NAME

area_reducer

yes

Statistic over region

mean

mean, median, min, max

export_path

no

Export CSV results to a Google cloud storage bucket (must have correct permissions)

climate-engine-public/my_csv_file.csv

export_format

no

File format of export

json

csv, json

/timeseries/native/forecasts/custom_asset

Generates timeseries of forecast values of the dataset variable and timeperiod between start_date and end_date for the features of a custom feature collection asset.
The values are averaged over the pixels lying within each feature of the feature collection.
Permissions on custom asset must be such that it is readable by anyone.
Returns: json

Resource url example:

/timeseries/native/forecasts/custom_asset?dataset=CFS_GRIDMET&variable=pet&start_day=day01&end_day=day28&asset_id=WCMC/WDPA/current/points&sub_choices= ["Golden Gate"]&filter_by=NAME

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

CFS_GRIDMET

CFS_GRIDMET

variable

yes

pet, pr, tmmn, tmmx

pet

model

yes

ens01 to en<xx> for individual models (see documentation), ens_min, ens_max, ens_mean, ens_median

ens_mean

ens_max

start_day

yes

day01 to day 28, start_day <= end_day

day01

day02

end_day

yes

day01 to day28, end_day >= start_day

day28

day15

asset_id

yes

Path to Earth Engine asset

WCMC/WDPA/current/points

sub_choices

no

List of features to use in analysis, must be strings

[“Golden Gate”]

filter_by

no

Property name to filter sub-choices

NAME

area_reducer

yes

Statistic over region

mean

mean, median, min, max

export_path

no

Export CSV results to a Google cloud storage bucket (must have correct permissions)

climate-engine-public/my_csv_file.csv

export_format

no

File format of export

json

csv, json

/timeseries/interannual/points

Generates timeseries of yearly values of the dataset variable summarized over a season at a point location.
Returns: json

Resource url example:

/timeseries/interannual/points?dataset=LANDSAT7_TOA&variable=NDVI&temporal_statistic=Mean&start_day=01&end_day=30&start_month=01&end_month=12&start_year=2016&end_year=2018&coordinates=[[-119.96,39.57], [-119, 39]]

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

LANDSAT7_TOA

variable

yes

NDVI

temporal_statistic

yes

mean

start_day

yes

01

end_day

yes

30

start_month

yes

01

end_month

yes

12

start_year

yes

2016

end_year

yes

2018

coordinates

yes

List of point coordinates

[[-119.96,39.57]]

buffers

no

List of integer buffers (meters) to be applied to each geometry

[400]

area_reducer

yes

Statistic over region

mean

mean, median, min, max

export_path

no

Export CSV results to a Google cloud storage bucket (must have correct permissions)

climate-engine-public/my_csv_file.csv

export_format

no

File format of export

json

csv, json

/timeseries/interannual/polygons

Generates timeseries of yearly values of the dataset variable summarized over a season for a polygon.
The values are averaged over the pixels lying within the polygon.
Returns: json

Resource url example:

/timeseries/interannual/polygons?dataset=LANDSAT7_TOA&variable=NDVI&temporal_statistic=Mean&start_day=01&end_day=30&start_month=01&end_month=12&start_year=2016&end_year=2018&coordinates=[[[-121.61,38.78], [-121.52,38.78],[-121.52,38.83],[-121.61,38.83],[-121.61,38.78]]]

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

LANDSAT7_TOA

variable

yes

NDVI

temporal_statistic

yes

mean

start_day

yes

01

end_day

yes

30

start_month

yes

01

end_month

yes

12

start_year

yes

2016

end_year

yes

2018

coordinates

yes

List of polygons coordinates

[[[-121.61,38.78], [-121.52,38.78],[-121.52,38.83],[-121.61,38.83],[-121.61,38.78]]]

buffers

no

List of integer buffers (meters) to be applied to each geometry

[400]

area_reducer

yes

Statistic over region

mean

mean, median, min, max

export_path

no

Export CSV results to a Google cloud storage bucket (must have correct permissions)

climate-engine-public/my_csv_file.csv

export_format

no

File format of export

json

csv, json

/timeseries/interannual/climate_engine_asset

Generates timeseries of yearly values of the dataset variable summarized over a season for the features of a Climate Engine feature collection asset.
The values are averaged over the pixels lying within each feature of the feature collection.
For a list of available assets see the Climate Engine Assets section.
Returns: json

Resource url example:

/timeseries/interannual/climate_engine_asset?dataset=LANDSAT7_TOA&variable=NDVI&temporal_statistic=Mean&start_day=01&end_day=30&start_month=01&end_month=12&start_year=2016&end_year=2016&region=counties&sub_choices=["AL - Dale"]

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

LANDSAT7_TOA

variable

yes

NDVI

temporal_statistic

yes

mean

start_day

yes

01

end_day

yes

30

start_month

yes

01

end_month

yes

12

start_year

yes

2016

end_year

yes

2018

region

yes

Type of feature collection

counties

sub_choices

no

List of features to use in analysis, must be strings

[“ME - Aroostook”]

area_reducer

yes

Statistic over region

mean

mean, median, min, max

export_path

no

Export CSV results to a Google cloud storage bucket (must have correct permissions)

climate-engine-public/my_csv_file.csv

export_format

no

File format of export

json

csv, json

/timeseries/interannual/custom_asset

Generates timeseries of yearly values of the dataset variable summarized over a season for the features of a custom feature collection asset.
The values are averaged over the pixels lying within each feature of the feature collection.
Permissions on custom asset must be such that it is readable by anyone.
Returns: json

Resource url example:

/timeseries/interannual/custom_asset?dataset=LANDSAT7_TOA&variable=NDVI&temporal_statistic=Mean&start_day=01&end_day=30&start_month=01&end_month=12&start_year=2014&end_year=2018&asset_id=WCMC/WDPA/current/points&sub_choices=["Golden Gate"]&filter_by=NAME

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

LANDSAT7_TOA

variable

yes

NDVI

temporal_statistic

yes

mean

start_day

yes

01

end_day

yes

30

start_month

yes

01

end_month

yes

12

start_year

yes

2016

end_year

yes

2018

asset_id

yes

Path to Earth Engine asset

WCMC/WDPA/current/points

sub_choices

no

List of features to use in analysis, must be strings

[“Golden Gate”]

filter_by

no

Property name to filter sub-choices

NAME

area_reducer

yes

Statistic over region

mean

mean, median, min, max

export_path

no

Export CSV results to a Google cloud storage bucket (must have correct permissions)

climate-engine-public/my_csv_file.csv

export_format

no

File format of export

json

csv, json

/timeseries/regression/points

Performs regression analysis of the dataset variable summarized over a season at a point location.
Returns: json

Resource url example:

/timeseries/regression/points?dataset=LANDSAT7_TOA&variable=NDVI&temporal_statistic=Mean&var2_dataset=LANDSAT7_TOA&var2_variable=NDSI&var2_temporal_statistic=Mean&start_day=01&end_day=30&start_month=01&end_month=12&var2_start_day=01&var2_end_day=30&var2_start_month=01&var2_end_month=12&start_year=2016&end_year=2018&coordinates=[[-119.96,39.57]]

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

LANDSAT7_TOA

variable

yes

NDVI

temporal_statistic

yes

mean

var2_dataset

yes

LANDSAT7_TOA

variable

yes

NDSI

temporal_statistic

yes

mean

start_day

yes

01

end_day

yes

30

start_month

yes

01

end_month

yes

12

var2_start_day

yes

01

var2_end_day

yes

30

var2_start_month

yes

01

var2_end_month

yes

12

start_year

yes

2016

end_year

yes

2018

coordinates

yes

List of point coordinates

[[-119.96,39.57]]

buffers

no

List of integer buffers (meters) to be applied to each geometry

[400]

area_reducer

yes

Statistic over region

mean

mean, median, min, max

export_path

no

Export CSV results to a Google cloud storage bucket (must have correct permissions)

climate-engine-public/my_csv_file.csv

export_format

no

File format of export

json

csv, json

/timeseries/regression/polygons

Performs regression analysis of the dataset variable summarized over a season for a polygon.
The values are averaged over the pixels lying within the polygon.
Returns: json

Resource url example:

/timeseries/regression/polygons?dataset=LANDSAT7_TOA&variable=NDVI&temporal_statistic=Mean&var2_dataset=LANDSAT7_TOA&var2_variable=NDSI&var2_temporal_statistic=Mean&start_day=01&end_day=30&start_month=01&end_month=12&var2_start_day=01&var2_end_day=30&var2_start_month=01&var2_end_month=12&start_year=2016&end_year=2018&coordinates=[[[-121.61,38.78], [-121.52,38.78],[-121.52,38.83],[-121.61,38.83],[-121.61,38.78]]]

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

LANDSAT7_TOA

variable

yes

NDVI

temporal_statistic

yes

mean

var2_dataset

yes

LANDSAT7_TOA

variable

yes

NDSI

temporal_statistic

yes

mean

start_day

yes

01

end_day

yes

30

start_month

yes

01

end_month

yes

12

var2_start_day

yes

01

var2_end_day

yes

30

var2_start_month

yes

01

var2_end_month

yes

12

start_year

yes

2016

end_year

yes

2018

coordinates

yes

List of point coordinates

[[[-121.61,38.78], [-121.52,38.78],[-121.52,38.83],[-121.61,38.83],[-121.61,38.78]]]

buffers

no

List of integer buffers (meters) to be applied to each geometry

[400]

area_reducer

yes

Statistic over region

mean

mean, median, min, max

export_path

no

Export CSV results to a Google cloud storage bucket (must have correct permissions)

climate-engine-public/my_csv_file.csv

export_format

no

File format of export

json

csv, json

/timeseries/regression/climate_engine_asset

Performs regression analysis of the dataset variable summarized over a season for the features of a Climate Engine feature collection asset.
The values are averaged over the pixels lying within each feature of the feature collection.
For a list of available assets see the Climate Engine Assets section.
Returns: json

Resource url example:

/timeseries/regression/climate_engine_asset?dataset=LANDSAT7_TOA&variable=NDVI&temporal_statistic=Mean&var2_dataset=LANDSAT7_TOA&var2_variable=NDSI&var2_temporal_statistic=Mean&start_day=01&end_day=30&start_month=01&end_month=12&var2_start_day=01&var2_end_day=30&var2_start_month=01&var2_end_month=12&start_year=2016&end_year=2018&region=counties&sub_choices= ["ME - Aroostook"]

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

LANDSAT7_TOA

variable

yes

NDVI

temporal_statistic

yes

mean

var2_dataset

yes

LANDSAT7_TOA

variable

yes

NDSI

temporal_statistic

yes

mean

start_day

yes

01

end_day

yes

30

start_month

yes

01

end_month

yes

12

var2_start_day

yes

01

var2_end_day

yes

30

var2_start_month

yes

01

var2_end_month

yes

12

start_year

yes

2016

end_year

yes

2018

region

yes

Type of feature collection

counties

sub_choices

no

List of features to use in analysis, must be strings

[“ME - Aroostook”]

area_reducer

yes

Statistic over region

mean

mean, median, min, max

export_path

no

Export CSV results to a Google cloud storage bucket (must have correct permissions)

climate-engine-public/my_csv_file.csv

export_format

no

File format of export

json

csv, json

/timeseries/regression/custom_asset

Performs regression analysis of the dataset variable summarized over a season for the features of a custom feature collection asset.
The values are averaged over the pixels lying within each feature of the feature collection.
Permissions on custom asset must be such that it is readable by anyone.
Returns: json

Resource url example:

/timeseries/regression/custom_asset?dataset=LANDSAT7_TOA&variable=NDVI&temporal_statistic=Mean&var2_dataset=LANDSAT7_TOA&var2_variable=NDSI&var2_temporal_statistic=Mean&start_day=01&end_day=30&start_month=01&end_month=12&var2_start_day=01&var2_end_day=30&var2_start_month=01&var2_end_month=12&start_year=2016&end_year=2018&asset_id=USGS/WBD/2017/HUC08&sub_choices=["Animas"]&filter_by=name

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

LANDSAT7_TOA

variable

yes

NDVI

temporal_statistic

yes

mean

var2_dataset

yes

LANDSAT7_TOA

variable

yes

NDSI

temporal_statistic

yes

mean

start_day

yes

01

end_day

yes

30

start_month

yes

01

end_month

yes

12

var2_start_day

yes

01

var2_end_day

yes

30

var2_start_month

yes

01

var2_end_month

yes

12

start_year

yes

2016

end_year

yes

2018

asset_id

yes

Path to Earth Engine asset

USGS/WBD/2017/HUC08

sub_choices

no

List of features to use in analysis, must be strings

[“Animas”]

filter_by

no

Property name to filter sub-choices

name

area_reducer

yes

Statistic over region

mean

mean, median, min, max

export_path

no

Export CSV results to a Google cloud storage bucket (must have correct permissions)

climate-engine-public/my_csv_file.csv

export_format

no

File format of export

json

csv, json