Skip to content
OTA-Pulse Docs

Get Deployment Stats

GET
/api/firmware/{firmware_id}/stats
 
curl --request GET \
  --url 'https://example.com/api/firmware/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/stats?organization_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'Authorization: Bearer <token>'

Get deployment statistics for a firmware version

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
firmware_id
required
Firmware Id
string format: uuid

Query Parameters

Section titled “ Query Parameters ”
organization_id
required
Organization Id
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
DeploymentStats

Deployment statistics

object
downloading
required
Downloading
integer
failed
required
Failed
integer
firmware_version
required
Firmware Version
string
installed
required
Installed
integer
installing
required
Installing
integer
pending
required
Pending
integer
success_rate
required
Success Rate
number
total_devices
required
Total Devices
integer
Example generated 
{
  "downloading": 1,
  "failed": 1,
  "firmware_version": "example",
  "installed": 1,
  "installing": 1,
  "pending": 1,
  "success_rate": 1,
  "total_devices": 1
}

422

Section titled “ 422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated 
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}