Skip to content
Brasil Data Commons Docs

Query events (POST)

POST
/v2/event

Fetch event data for Data Commons event entities and event collections.

Request Body required

Section titled “Request Body required ”

EventCollection: node = ‘country/USA’ property = ’<-location{typeOf:FireEvent, date:2020-10, area:3.1#6.2#Acre}’ NOTE:

  • burnedArea:3.14#6.28#Acre means filterProp:lowerLimit#upperLimit#unit
  • The format of ‘date’ is YYYY-MM.

EventCollectionDate: node = ‘country/USA’ property = ‘<-location{typeOf:FireEvent}->date’,

Two modes are supported:

EventCollection: node = ‘country/USA’ property = ’<-location{typeOf:FireEvent, date:2020-10, area:3.1#6.2#Acre}’ NOTE:

  • burnedArea:3.14#6.28#Acre means filterProp:lowerLimit#upperLimit#unit
  • The format of ‘date’ is YYYY-MM.

EventCollectionDate: node = ‘country/USA’ property = ‘<-location{typeOf:FireEvent}->date’,

object
node
string
property
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

A successful response.

object
eventCollection

A collection of events that share some common properties.

object
events
Array<object>
object
places

Data Commons places associated with the event. NOTE: All S2Cell places (ID has “s2CellId/” prefix) are excluded.

Array<string>
geoLocations

Geospatial location of the event.

Array<object>
object
point
object
latitude

Optional is needed here to prevent 0 values from getting dropped.

number format: double
longitude
number format: double
polygon
object
geoJson
string
dates

The format should be ISO 8601.

Array<string>
propVals

Key: salient property.

object
key
additional properties
object
vals
Array<string>
dcid
string
provenanceId
string
provenanceInfo

Key: provenance ID. Only provenance IDs present in |events| are included.

object
key
additional properties
object
importName
string
provenanceUrl
string
domain
string
eventCollectionDate
object
dates

Format: YYYY-MM, corresponding to the date in EventCollection cache key. Sorted from earliest to latest.

Array<string>

default

Section titled “default ”

An unexpected error response.

object
code
integer format: int32
message
string
details
Array<object>
object
@type
string
key
additional properties