campaign.member.list

TR50 Request


                        {
  "cmd": {
    "command": "campaign.member.list",
    "params": {
      "campaignId": "53a00cb831004657ad0bf666"
    }
  }
}

Request Parameters


Name	Type	Required	Description
campaignId	String	Yes	The unique identifier of the campaign.
sort	Array		One or more field names by which results are sorted. Preceding a field name with a negative sign sorts it in reverse order.
offset	Integer		The starting list offset, used for pagination. Defaults to 0 if not specified.
limit	Integer		Limit the number of results returned. Defaults to the configured maximum limit.
failedOnly	Boolean		Limit the result to only failed things

TR50 Response

If the command is sent successfully a success message is returned. Otherwise, an error and error message will be returned.


                            {
  "cmd":  {
        "success": true,
        "params": {
            "count": 2,
            "result": [
               {
                    "id": "5aa8b2b1fe2a13158c5c4b70",
                    "params": {
                        "key": "x64_engr_14_125",
                        "name": "auto:x64_engr_14_125"
                    },
                    "status": "success",
                    "ts": "2018-03-14T05:29:14.777Z",
                    "startedOn": "2018-03-14T20:31:22.38Z",
                    "completedOn": "2018-03-14T20:31:22.392Z",
                    "createdBy": "admin@telit.com",
                    "createdOn": "2018-03-14T20:31:01.384Z"
                },
                {
                    "id": "5aa98685fe2a137798d4dc67",
                    "params": {
                        "key": "x64_engr_14_126",
                        "name": "auto:x64_engr_14_126"
                    },
                    "status": "failure",
                    "ts": "2018-03-14T20:31:22.392Z",
                    "startedOn": "2018-03-14T20:31:22.38Z",
                    "completedOn": "2018-03-14T20:31:22.392Z",
                    "errorMessage": "SUP 'STAGING_DEPLOY_12M_FILE.sup.sup' not found.",
                    "errorCode": -90008,
                    "createdBy": "admin@telit.com",
                    "createdOn": "2018-03-14T20:31:01.384Z"
                }
            ]
        }
    }
}

Response Parameters


Name	Type	Description
count	Integer	The total number of matching things.
result	Array	An array consisting of result objects.

Result Object


Name	Type	Description
id	String	The unique identifier of a member.
key	String	The member thing's/connection's key.
name	String	The member thing's/connection's name
status	String	The current state of the campaign member's execution: ready: The thing/connection is ready for the campaign to run. inProgress: The campaign is in progress. success: The campaign successfully . failure: The number of tasked things that have failed during execution.
ts	String	Timestamp associated with campaign member's execution.
startedOn	Timestamp	The start time of the campaign.
completedOn	Timestamp	The end time of the campaign.
errorCode	Integer	If execution failed, the error message that was received during execution of the campaign task on the member.
errorMessage	String	If execution failed, the error message that was received during execution.
createdBy	String	The creator of the campaign.
createdOn	String	The creation timestamp of the campaign.