Please specify the parameters required following the instruction:

API Query parameters

The API allows to retrieve data for individual observation areas and for a specific time period. Other options specify the output data format and other parameters. The parameters are:

 

API

Description

Default value

Required

areaid

All

The unique identifier of the observation area

All

Optional

siteid

All

The DFO site ID (for backwards compatibility). areaid has precedence.

All

Optional

type

All

The output format:

·         txt: text separated by semi-colon (;)

·         html: HTML table

·         rss: GeoRSS format (http://www.georss.org/)

·         kml: OGC KML (http://www.opengeospatial.org/standards/kml)

·         jsonfull: the main json format

·         json: short json format

·         csv (areaid,date,avgsignal,avgmagnitude)

txt

Optional

from

All

Start date of extraction

Yesterday

Optional

to

All

End date of extraction

Today

Optional

datatype

All

Daily value or running average for smoothing and accounting for missing data:

·         DAILY: Daily value (with missing data)

·         4DAYS: average of past 4 days (less missing data)

4DAYS

Optional

alertlevel

All

A magnitude based threshold. Magnitude is the number of standard deviation the current signal is above the mean of 2002-2008. Values exceeding the threshold are extracted.

 

For point sites (one pixel):

·         RED: magnitude > 4

·         ORANGE: magnitude > 2

·         GREEN: all the rest

For area sites (multiple pixels)

·         RED: more than 20% of pixels have magnitude > 4

·         ORANGE: more than 20% of pixels have magnitude > 2

·         GREEN: otherwise

RED

Optional

source

V4

The sensor data source

·         DFO: see single sensor product

·         DFOMERGE: see merged product

·         GPM: only GPM samples

n/a

Required

 

API Output

The API produces the following output in a variety of formats.

Field name

Description

Value lists

Only multi-pixel areas

AreasDataId

Unique data point ID

 

 

AreaId

Area ID

 

 

Country

Country name

 

 

AlertLevel

Anomaly level: GREEN, ORANGE or RED (see table above for explanation)

GREEN

ORANGE

RED

 

Description

Area name or description

 

 

TypePointArea

Type of area: single pixel or multiple pixels

P: Single pixel

A: Multiple pixel

 

PointsInJsonFormat

List of coordinates of pixels in json format

 

 

PointsNumber

Number of pixels

 

 

BoundingBoxLonMin

Minimum longitude of bounding box

[-180,180]

 

BoundingBoxLonMax

Maximum longitude of bounding box

[-180,180]

 

BoundingBoxLatMin

Minimum latitude of bounding box

[-90,90]

 

BoundingBoxLatMax

Maximum latitude of bounding box

[-90,90]

 

Population

Population near location (deprecated)

 

 

River

River near location (deprecated)

 

 

Cities

Cities near location (deprecated)

 

 

Slope

Maximum slope (derived from 1km resolution DEM) (deprecated)

 

 

Xml

List of critical features (deprecated)

 

 

Dams

List of critical features (deprecated)

 

 

Agriculture

Area of agricultural land (deprecated)

 

 

Urban

Area of urban land (deprecated)

 

 

Comments

Comments

 

 

DataType

Daily sample or running average over 4 days

DAILY

4DAYS

 

RecordDate

Date in format D/M/YYYY 12:00:00

 

 

RecordDateInteger

Data in format YYYYDDMM

 

 

SignalAvg

For single-pixel areas: signal value

For multi-pixel areas: average signal over all pixels

 

 

SignalSd

Standard deviation of signal values

 

Yes

SignalMin

Minimum signal value of all pixels in the area

 

Yes

MagnitudeAvg

For single-pixel areas: magnitude value

For multi-pixel areas: average magnitude value over all pixels

 

 

MagnitudeSd

Standard deviation of magnitude values

 

Yes

MagnitudeMax

Maximum magnitude value of all pixels in the area

 

Yes

MagGreatEqual2Count

Number of pixels with magnitude > 2

 

Yes

MagGreatEqual4Count

Number of pixels with magnitude > 4

 

Yes

PixelIndexesMagGE2

Index of pixels exceeding magnitude 2

 

Yes

PixelIndexesMagGE4

Index of pixels exceeding magnitude 4

 

Yes

MValue

Brightness temperature of measurement pixel (last value of the day)

 

 

CValue

Brightness temperature of calibration pixel (last value of the day)

 

 

PValue

Position of calibration pixel (last value of the day).

[1-81]

 

 

Note that the signal is not always equal to the ratio of M/C. The signal is the average of all samples of the day, while the M, C, P values are those of the last sample of the day.