diff --git a/pool-stats-api-reference/openapi.json b/pool-stats-api-reference/openapi.json index 50385c9..6f125a9 100644 --- a/pool-stats-api-reference/openapi.json +++ b/pool-stats-api-reference/openapi.json @@ -25,10 +25,10 @@ "name": "group_by", "in": "query", "required": false, - "description": "Additional dimension(s) to group results by (comma-separated). Results are always grouped by server_region. This parameter adds additional grouping on top. Examples: \"country\", \"city\", \"asn\", \"zip\", \"country,city\"", + "description": "Additional dimension(s) to group results by (comma-separated). Results are always grouped by server_region. This parameter adds additional grouping on top. Examples: \"country\", \"city\", \"asn\", \"zip\", \"device_type\", \"country,city\"", "schema": { "type": "string", - "pattern": "^(country|subdivision|city|asn|zip)(,(country|subdivision|city|asn|zip))*$" + "pattern": "^(country|subdivision|city|asn|zip|pool_type|device_type)(,(country|subdivision|city|asn|zip|pool_type|device_type))*$" } }, { @@ -101,6 +101,26 @@ "maxLength": 20, "example": "10001" } + }, + { + "name": "pool_type", + "in": "query", + "required": false, + "description": "Filter by pool type", + "schema": { + "type": "string", + "example": "residential" + } + }, + { + "name": "device_type", + "in": "query", + "required": false, + "description": "Filter by device type (mobile, tv, or common)", + "schema": { + "type": "string", + "example": "mobile" + } } ], "responses": { @@ -147,6 +167,16 @@ "description": "ZIP/postal code (present when grouping by zip)", "nullable": true }, + "pool_type": { + "type": "string", + "description": "Pool type (present when grouping by pool_type)", + "nullable": true + }, + "device_type": { + "type": "string", + "description": "Device type (mobile, tv, or common) (present when grouping by device_type)", + "nullable": true + }, "count": { "type": "integer", "description": "Number of active nodes in this group" diff --git a/pool-stats-api-reference/pool-stats-api-introduction.mdx b/pool-stats-api-reference/pool-stats-api-introduction.mdx index bcf99df..d4c7554 100644 --- a/pool-stats-api-reference/pool-stats-api-introduction.mdx +++ b/pool-stats-api-reference/pool-stats-api-introduction.mdx @@ -6,7 +6,7 @@ description: 'The Pool Stats API provides real-time statistics about the node po # Key Features - Get live node pool statistics with filtering -- Group results by various dimensions (country, city, ASN, ZIP) +- Group results by various dimensions (country, city, ASN, ZIP, pool type, device type) - Retrieve available server regions # Getting Started