Skip to content
Brasil Data Commons Docs

Bulk variable info (POST)

POST
/v1/bulk/info/variable

Fetch metadata for multiple statistical variables.

Request Body required

Section titled “Request Body required ”
object
nodes
Array<string>

Responses

Section titled “ Responses ”

200

Section titled “200 ”

A successful response.

object
data
Array<object>
object
node
string
info
Summary information about a StatVar
object
placeTypeSummary

Key: type of place. When places have multiple types, the dominant place type is selected.

object
key
additional properties
object
placeCount
Number of places with stats for this StatVar
integer format: int32
topPlaces
A short (<4) list of most-populated places of this type
Array<object>
object
dcid
string
name
string
minValue
Minimum observation value for places of this type
number format: double
maxValue
Maximum observation value for places of this type
number format: double
provenanceSummary
Key: provenance ID
object
key
additional properties
object
importName
Import name
string
releaseFrequency
Release frequency of this provenance
string
seriesSummary
SeriesSummary for each time series in this provenance
Array<object>
object
seriesKey
object
measurementMethod
Measurement method of this time series type
string
observationPeriod
Observation period of this time series type
string
scalingFactor
Scaling factor of this time series type
string
unit
Unit of this time series type
string
isDcAggregate
Whether this time series type is aggregated by Data Commons
boolean
isDcImputed
Whether this time series type is imputed by Data Commons
boolean
earliestDate
Earliest observation date of this time series type
string
latestDate
Latest observation date in this time series type
string
placeTypeSummary
Map of place type to PlaceTypeSummary for this time series type
object
key
additional properties
object
placeCount
Number of places with stats for this StatVar
integer format: int32
topPlaces
A short (<4) list of most-populated places of this type
Array<object>
object
dcid
string
name
string
minValue
Minimum observation value for places of this type
number format: double
maxValue
Maximum observation value for places of this type
number format: double
minValue
Minimum observation value of this time series type
number format: double
maxValue
Maximum observation value of this time series type
number format: double
observationCount

Number of observations of this time series type, might exceed INT32_MAX.

number format: double
timeSeriesCount

Number of series of this time series type, might exceed INT32_MAX.

number format: double
observationCount

Number of observations from this provenance, might exceed INT32_MAX.

number format: double
timeSeriesCount

Number of time series from this provenance, might exceed INT32_MAX.

number format: double

default

Section titled “default ”

An unexpected error response.

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