Skip to main content

Get Deployment Report

GET 
/api/v1/catalog/releases/project/:projectIdentifier/version/:version/deployment-report

Generates a comprehensive deployment report for a specific release, including download stats, installation counts, active delivery processes, and deployment percentage.

Request​

Path Parameters

    projectIdentifier stringrequired

    Project identifier (ID or name)

    version stringrequired

Header Parameters

    X-Project-Token string

Responses​

Deployment report with analytics

Schema

    projectId numberrequired

    Project ID

    releaseName stringrequired

    Release name

    version stringrequired

    Release version

    downloadedCount numberrequired

    Number of devices that have downloaded the release

    installedCount numberrequired

    Number of devices with the release installed

    total numberrequired

    Total number of devices with ongoing delivery process (includes devices waiting for download and mid-deployment)

    pending numberrequired

    Number of devices that are pending (not downloaded or still downloading)

    deploymentPercentage numberrequired

    Deployment percentage calculated as (installedCount / activeDeliveryCount) * 100

    devices

    object[]

    required

    List of devices with their deployment statuses

  • Array [

    • deviceId stringrequired

    Device ID

    deviceName string

    Device name

    deliveryStatus string

    Delivery status (e.g., DONE, PENDING, IN_PROGRESS)

    deployStatus string

    Deploy/Installation status (e.g., DONE, PENDING, IN_PROGRESS)

    downloadTime date-time

    Download completion timestamp

    installationTime date-time

    Installation completion timestamp

  • ]

Loading...