Query data collection data

Returns data stored in a particular dataset of the specified data collection for the given combination of filters.

GET /my-organization/data-collection-resources/:data_collection_id/datasets/:data_type/data

Where:

Parameter	Description
:data_collection_id	The queried data collection
:data_type	The queried data type

Parameters

Parameter	Description	Required
age_group_id	Age group identifier	Yes
cause_id	Cause identifier	Yes
covariate_id	Covariate identifier	Yes
forecast_scenario_id	Forecast scenario identifier	Yes
gender_id	Gender identifier	Yes
location_id	Location identifier	Yes
measure_id	Measure identifier	Yes
metric_id	Metric identifier	Yes
rei_id	Risk, etiology, or impairment identifier	Yes
round_id	Round identifier	Yes
sequela_id	Sequela identifier	Yes
year	Year	No

Multiple filter ids can be passed as a comma-separated list in one request.

Note that IHME Portal stores more data than can be returned in a single request. If you request more data than can be handled by the system's capacity, a corresponding error will be returned. Please refine your search by splitting it into several smaller requests in such case.

Also, despite the fact that most of the query parameters are marked as optional, it is highly recommended to specify all the search parameters for the best performance.

Response

The endpoint returns a data response, where columns contain a list of data filters, and records contain a list of records with correspondingly positioned values.

{
    "data": {
        "columns": [ <string> ],
        "records": [ <number> ]
    }
}

Example

GET /my-organization/data-collection-resources/183/datasets/cause_outcome/data?age_group_id=22&cause_id=345%2C346&gender_id=3&location_id=1&measure_id=1&metric_id=3&round_id=5

{
    "data": {
        "columns": ["location_id", "year", "gender_id", "age_group_id", "cause_id", "value", "lower", "upper", "measure_id", "metric_id", "round_id"],
        "records": [
            [1, 2017, 3, 22, 345, 8.112419244347244, 5.760552147049214, 10.987782249868815, 1, 3, 5],
            [1, 2016, 3, 22, 345, 8.284266197192725, 5.874752706281531, 11.161025320022823, 1, 3, 5],
            ...,
            [1, 1990, 3, 22, 346, 0.16598862237783824, 0.1597706282559287, 0.17249236722923705, 1, 3, 5]
        ]
    }
}