IBM Watson IoT Platform Analytics Real-Time Insights API

Live

IBM Watson IoT Platform Analytics Real-Time Insights API

+ Day(s) remaining in the trial

Overview

With IBM Watson IoT Platform Real-Time Insights on Bluemix (IoT Real-Time Insights), you can perform analytics on real-time data from your Internet of Things devices, and gain insights about their health and the overall state of your operations.

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Documentation

IBM Watson IoT Platform Analytics Real-Time Insights API:

Action

Create an action
Create an action with the information that is defined in the request body. An action id is generated by the system and returned from the response.

POST   /action

			https://iotrti-prod.mam.ibmserviceengage.com/api/action
		
Keys
Request code
								
HttpResponse<String> response = Unirest.post("https://api.ibm.com/api/action") .header("accept", "application/json") .header("content-type", "application/json") .asString();
Request model

description

STRING , optional

The description of the action.

name

STRING , optional

The name of the action.

type

OBJECT , optional

The type of the action.

fields

OBJECT , optional

The fields of the action. The exact structure depends on type.

Request example
{
  "description": string,
  "name": string,
  "type": object,
  "fields": object
}
Response model

200

OK

Body

id

STRING , optional

The unique ID of the action.

updated

STRING , optional

ISO8601 date and time of when the action was last updated.

created

STRING , optional

ISO8601 date and time of when the action was created.

Response example

200

OK

								{
  "id" : string,
  "updated" : string,
  "created" : string
}
							
Delete an action
Delete the action that is specified by the action id.

DELETE   /action/{id}

			https://iotrti-prod.mam.ibmserviceengage.com/api/action/{id}
		
Keys
Path and Query parameters

id

URL , optional

action ID

Request code
								
HttpResponse<String> response = Unirest.delete("https://api.ibm.com/api/action/%7Bid%7D") .header("accept", "application/json") .header("content-type", "application/json") .asString();
Get a list of actions
Retrieve a list of action of the specified `type`. All defined actions are returned if no `type` parameter specified.

GET   /action

			https://iotrti-prod.mam.ibmserviceengage.com/api/action
		
Keys
Path and Query parameters

type

STRING , optional

action type

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/api/action?type=SOME_STRING_VALUE") .header("accept", "application/json") .header("content-type", "application/json") .asString();
Response model

200

OK

Body

id

STRING , optional

The unique ID of the action.

updated

STRING , optional

ISO8601 date and time of when the action was last updated.

created

STRING , optional

ISO8601 date and time of when the action was created.

Response example

200

OK

								{
  "id" : string,
  "updated" : string,
  "created" : string
}
							
Get an action
Retrieve the action that is specified by the action id.

GET   /action/{id}

			https://iotrti-prod.mam.ibmserviceengage.com/api/action/{id}
		
Keys
Path and Query parameters

id

URL , optional

action ID

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/api/action/%7Bid%7D") .header("accept", "application/json") .header("content-type", "application/json") .asString();
Response model

200

OK

Body

id

STRING , optional

The unique ID of the action.

updated

STRING , optional

ISO8601 date and time of when the action was last updated.

created

STRING , optional

ISO8601 date and time of when the action was created.

Response example

200

OK

								{
  "id" : string,
  "updated" : string,
  "created" : string
}
							
Update an action
Update the action that is specified by the action id and the request body.

PUT   /action/{id}

			https://iotrti-prod.mam.ibmserviceengage.com/api/action/{id}
		
Keys
Path and Query parameters

id

URL , optional

action ID

Request code
								
HttpResponse<String> response = Unirest.put("https://api.ibm.com/api/action/%7Bid%7D") .header("accept", "application/json") .header("content-type", "application/json") .asString();
Request model

description

STRING , optional

The description of the action.

name

STRING , optional

The name of the action.

type

OBJECT , optional

The type of the action.

fields

OBJECT , optional

The fields of the action. The exact structure depends on type.

Request example
{
  "description": string,
  "name": string,
  "type": object,
  "fields": object
}
Response model

200

OK

Body

id

STRING , optional

The unique ID of the action.

updated

STRING , optional

ISO8601 date and time of when the action was last updated.

created

STRING , optional

ISO8601 date and time of when the action was created.

Response example

200

OK

								{
  "id" : string,
  "updated" : string,
  "created" : string
}
							

Loading content...