Get install/active/failure metrics for a deployment

GET

/v1/apps/{appName}/deployments/{deploymentName}/metrics

const url = 'https://api.aetherpush.com/v1/apps/example/deployments/example/metrics';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aetherpush.com/v1/apps/example/deployments/example/metrics \
  --header 'Authorization: Bearer <token>'

Returns per-release metrics (active installs, downloads, install results) for the deployment, keyed by release label or appVersion. Returns an empty object if Redis (the metrics backend) is not configured.

Authorizations

accessKeyAuth
apiKeyAuth
read

Parameters

Path Parameters

appName

required

string

deploymentName

required

string

Responses

200

Metrics map.

application/json

object

metrics

required

Map keyed by package label (e.g. v3) or app version (e.g. 1.0.0) when the client did not have a CodePush package installed.

object

key

additional properties

object

active

required

integer

downloaded

integer

failed

integer

installed

integer

Example

{
  "metrics": {
    "v3": {
      "active": 1240,
      "downloaded": 1300,
      "installed": 1280,
      "failed": 20
    },
    "1.0.0": {
      "active": 50
    }
  }
}

401

Unauthenticated, or not a collaborator.

application/json

object

error

required

Human-readable error message.

string

requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Example

{
  "error": "The requested resource was not found.",
  "requestId": "req_abc123"
}

404

App or deployment not found.

application/json

object

error

required

Human-readable error message.

string

requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Example

{
  "error": "The requested resource was not found.",
  "requestId": "req_abc123"
}