Get primary entity and round specific granularity

Returns data granularity for given primary entity and round within a particular dataset of specified data collection. The returned granularity is a subset of the dataset granularity with filter values relevant to the selected primary entity.

Note that it is still possible that there is no modeled data for some combinations of filters. To check for what genders, age groups, locations, and measure the data wasn't modeled, have a look at the Condition Detail Notes API below.

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

Where:

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

Parameters

Parameter	Description	Optional
round_id	Unique round identifier	No
primary_entity_id	Primary entity id. Multiple primary entity ids can be passed as a comma-separated list	No

Response

The endpoint returns a granularity object, which contains the id-values available for each of the relevant filters:

{
    "data": {
        <filter_1>: [<int>],
        <filter_2>: [<int>],
        ...,
        <filter_n>: [<int>],
    }
}

Example

GET /my-organization/data-collection-resources/183/cause_outcome/granularity?primary_entity_id=345,346&round_id=6

{
    "data": {
        "age_group_id": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 28, 30,…]
        "cause_id": [345, 346]
        "gender_id": [1, 2, 3]
        "location_id": [1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,…]
        "measure_id": [1, 4]
        "metric_id": [1, 3]
        "round_id": [6]
        "year": [1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,…]
    }
}

Note, that returned cause_id and round_id match the request query parameters.