Mistake on this page? Email us

Campaign metrics with the APIs

When a campaign is in the active, stopped, or archived phase, you can view campaign metrics:

curl -X GET https://api.us-east-1.mbedcloud.com/v3/update-campaigns/<campaign_id>/metrics
-H "Authorization: Bearer <api_key>"

This returns metrics information:

{
     "created_at":"<timestamp>",
     "success_count":0,
     "failed_count":0,
     "pending_count":1,
     "total_count":1
}

This tells you how many devices updated successfully, how many failed to update, how many are still pending and how many total devices are or were in your campaign. It does not include information on which specific devices are in these states.