Skip to content

[PROXY-201] Add device_type grouping to Pool API stats docs #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
giannimassive wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[PROXY-201] Add device_type grouping to Pool API stats docs #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 32 additions & 2 deletions pool-stats-api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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))*$"
}
},
{
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion pool-stats-api-reference/pool-stats-api-introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down