Get Regional Distribution Details

Last Updated on : 2023-06-15 05:10:29

Get the regional distribution details of activated devices based on the time format, product, and regional type. The details of cities are not included in the country and region data.

API address

GET: /v1.1/devices/locations-active-datas

Request parameter

Parameter name	Type	IN	Required	Description
date_type	String	query	true	The time format. Valid values: `day`: day `week`: week `weeks`: two weeks `month`: month
product_id	String	query	false	The product ID. If you do not set the parameter, all your product IDs will be returned.
type	String	query	true	The scope of the region. Valid values: `country`: country/region `province`: province `city`: city
limit	Integer	query	true	The limit. Valid values: 0 to 100.

Return parameter

Parameter name	Type	Description
result	JSONArray	The returned result.

Description of result

Parameter name	Type	Description
percentage	String	The number of regional activated devices divided by the total number of activated devices.
name	String	The name of the region.
value	Integer	The total number of activated devices in the region.

Request example

GET: /v1.1/devices/locations-active-datas?date_type=week&productId=123&type=province&limit=3

Return example

{
    "result": [
        {
            "percentage": "25.00%",
            "name": "Hunan Province",
            "value": 2
        },
        {
            "percentage": "25.00%",
            "name": "Others",
            "value": 2
        }
    ],
    "t": 1544411872724,
    "success": true
}

Error code

For more information, see error code.

Prev DocGet Effective Interaction Data

Next DocGet an Overview of Activated Device Data