App Launch

Beta

App Launch

+ Day(s) remaining in the trial

Overview

Use App Launch API to

1. Configure features, messages, custom audience attributes, audiences based on audience attributes and finally engagements that choreographs the timing and placement of the features and messages
2. Manage device registrations and its actions
3. Post sessions and metric events from device
4. Collect insights on app usage

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
 

Global Parameters

This section contains global variables, which apply to all of the endpoint definitions of this API. You can use this section to set these variables once, and have the values pre-filled for every endpoint in the Documentation section. The values set can be used with the built-in testing. You can always override the value in the endpoint definition of the Documentation section.
Global variables

Documentation

App Launch:

Audiences

Create an audience

POST   /apps/{applicationId}/audiences

			https://applaunch.ng.bluemix.net/applaunch/v1/apps/{applicationId}/audiences
		
Keys
Header parameters

appSecret

STRING , required

The appSecret associated with this application

Global variables

Hostname

STRING , required

Path and Query parameters

applicationId

URL , required

Unique ID of the application using the app launch service

Request code
								
HttpResponse<String> response = Unirest.post("https://{Hostname}/applaunch/v1/apps/{applicationId}/audiences") .header("appsecret", "string") .header("accept", "application/json") .body("{\"attributes\":[{\"attributeName\":\"string\",\"values\":{\"description\":\"Values of the attribute. Either \\\"in\\\" OR \\\"gt\\\" and/or \\\"lt\\\" are allowed\",\"properties\":{\"gt\":{\"description\":\"Should be either number or date type\"},\"in\":[null],\"lt\":{\"description\":\"Should be either number or date type\"}},\"type\":\"object\"}}],\"description\":\"string\",\"name\":\"string\"}") .asString();
Request model

name

STRING , required

Name of the audience

description

STRING , optional

Brief description about the audience

attributes

ARRAY , required

List of attributes for this audience

attributeName

STRING , required

Name of the attribute

values

OBJECT , required

Values of the attribute. Either "in" OR "gt" and/or "lt" are allowed

in

ARRAY , optional

Array should be of string, number, boolean or date type

gt

STRING , optional

lt

STRING , optional

Request example
{
  "name": string,
  "description": string,
  "attributes": [{
    "attributeName": string,
    "values": {
    "in": [],
    "gt": string,
    "lt": string
  }
  }]
}
Response model

201

Successful request.

Body

name

STRING , required

Name of the audience

description

STRING , optional

Brief description about the audience

attributes [AttributesInAudienceModel]

ARRAY , required

List of attributes for this audience

attributeName

STRING , required

Name of the attribute

values

OBJECT , required

Values of the attribute. Either "in" OR "gt" and/or "lt" are allowed

in [NumberDateStringBooleanValue]

ARRAY , optional

Array should be of string, number, boolean or date type

gt

STRING , optional

lt

STRING , optional

400

Bad request.

401

Unauthorized.

404

Application doesn't exist.

Response example

201

Successful request.

								{
  "name" : string,
  "description" : string,
  "attributes" : [{
    "attributeName" : string,
    "values" : {
    "in" : [array],
    "gt" : string,
    "lt" : string
  }
  }]
}
							

400

Bad request.

401

Unauthorized.

404

Application doesn't exist.

Create an audience attribute

POST   /apps/{applicationId}/audienceAttributes

			https://applaunch.ng.bluemix.net/applaunch/v1/apps/{applicationId}/audienceAttributes
		
Keys
Header parameters

appSecret

STRING , required

The appSecret associated with this application

Global variables

Hostname

STRING , required

Path and Query parameters

applicationId

URL , required

Unique ID of the application using the app launch service

Request code
								
HttpResponse<String> response = Unirest.post("https://{Hostname}/applaunch/v1/apps/{applicationId}/audienceAttributes") .header("appsecret", "string") .header("accept", "application/json") .body("{\"dataType\":\"string\",\"description\":\"string\",\"name\":\"string\"}") .asString();
Request model

name

STRING , required

Name of the attribute

description

STRING , optional

Brief description about the attribute

dataType

STRING , required

Data type of the attribute

Request example
{
  "name": string,
  "description": string,
  "dataType": [string, number, date, boolean]
}
Response model

201

Successful request.

Body

name

STRING , required

Name of the attribute

description

STRING , optional

Brief description about the attribute

dataType

STRING , required

Data type of the attribute

400

Bad request.

401

Unauthorized.

404

Application doesn't exist.

409

Conflict.

Response example

201

Successful request.

								{
  "name" : string,
  "description" : string,
  "dataType" : [string, number, date, boolean]
}
							

400

Bad request.

401

Unauthorized.

404

Application doesn't exist.

409

Conflict.

Delete an audience

DELETE   /apps/{applicationId}/audiences/{audienceName}

			https://applaunch.ng.bluemix.net/applaunch/v1/apps/{applicationId}/audiences/{audienceName}
		
Keys
Header parameters

appSecret

STRING , required

The appSecret associated with this application

Global variables

Hostname

STRING , required

Path and Query parameters

applicationId

URL , required

Unique ID of the application using the app launch service

audienceName

URL , required

Name of the audience

Request code
								
HttpResponse<String> response = Unirest.delete("https://{Hostname}/applaunch/v1/apps/{applicationId}/audiences/{audienceName}") .header("appsecret", "string") .header("accept", "application/json") .asString();
Response model

204

Successful request.

400

Bad request.

401

Unauthorized.

404

Application doesn't exist.

Response example

204

Successful request.

400

Bad request.

401

Unauthorized.

404

Application doesn't exist.

Delete an audience attribute

DELETE   /apps/{applicationId}/audienceAttributes/{attributeName}

			https://applaunch.ng.bluemix.net/applaunch/v1/apps/{applicationId}/audienceAttributes/{attributeName}
		
Keys
Header parameters

appSecret

STRING , required

The appSecret associated with this application

Global variables

Hostname

STRING , required

Path and Query parameters

applicationId

URL , required

Unique ID of the application using the app launch service

attributeName

URL , required

Name of the audience attribute

Request code
								
HttpResponse<String> response = Unirest.delete("https://{Hostname}/applaunch/v1/apps/{applicationId}/audienceAttributes/{attributeName}") .header("appsecret", "string") .header("accept", "application/json") .asString();
Response model

204

Successful request.

400

Bad request.

401

Unauthorized.

404

Application/Attribute doesn't exist.

Response example

204

Successful request.

400

Bad request.

401

Unauthorized.

404

Application/Attribute doesn't exist.

Get an audience

GET   /apps/{applicationId}/audiences/{audienceName}

			https://applaunch.ng.bluemix.net/applaunch/v1/apps/{applicationId}/audiences/{audienceName}
		
Keys
Header parameters

appSecret

STRING , required

The appSecret associated with this application

Global variables

Hostname

STRING , required

Path and Query parameters

applicationId

URL , required

Unique ID of the application using the app launch service

audienceName

URL , required

Name of the audience

Request code
								
HttpResponse<String> response = Unirest.get("https://{Hostname}/applaunch/v1/apps/{applicationId}/audiences/{audienceName}") .header("appsecret", "string") .header("accept", "application/json") .asString();
Response model

200

Successful request.

Body

name

STRING , required

Name of the audience

description

STRING , optional

Brief description about the audience

attributes [AttributesInAudienceModel]

ARRAY , required

List of attributes for this audience

attributeName

STRING , required

Name of the attribute

values

OBJECT , required

Values of the attribute. Either "in" OR "gt" and/or "lt" are allowed

in [NumberDateStringBooleanValue]

ARRAY , optional

Array should be of string, number, boolean or date type

gt

STRING , optional

lt

STRING , optional

401

Unauthorized.

404

Application doesn't exist.

Response example

200

Successful request.

								{
  "name" : string,
  "description" : string,
  "attributes" : [{
    "attributeName" : string,
    "values" : {
    "in" : [array],
    "gt" : string,
    "lt" : string
  }
  }]
}
							

401

Unauthorized.

404

Application doesn't exist.

Get an audience attribute

GET   /apps/{applicationId}/audienceAttributes/{attributeName}

			https://applaunch.ng.bluemix.net/applaunch/v1/apps/{applicationId}/audienceAttributes/{attributeName}
		
Keys
Header parameters

appSecret

STRING , required

The appSecret associated with this application

Global variables

Hostname

STRING , required

Path and Query parameters

applicationId

URL , required

Unique ID of the application using the app launch service

attributeName

URL , required

Name of the audience attribute

Request code
								
HttpResponse<String> response = Unirest.get("https://{Hostname}/applaunch/v1/apps/{applicationId}/audienceAttributes/{attributeName}") .header("appsecret", "string") .header("accept", "application/json") .asString();
Response model

200

Successful request.

Body

name

STRING , required

Name of the attribute

description

STRING , optional

Brief description about the attribute

dataType

STRING , required

Data type of the attribute

401

Unauthorized.

404

Application/Attribute doesn't exist.

Response example

200

Successful request.

								{
  "name" : string,
  "description" : string,
  "dataType" : [string, number, date, boolean]
}
							

401

Unauthorized.

404

Application/Attribute doesn't exist.

Update an audience

PUT   /apps/{applicationId}/audiences/{audienceName}

			https://applaunch.ng.bluemix.net/applaunch/v1/apps/{applicationId}/audiences/{audienceName}
		
Keys
Header parameters

appSecret

STRING , required

The appSecret associated with this application

Global variables

Hostname

STRING , required

Path and Query parameters

applicationId

URL , required

Unique ID of the application using the app launch service

audienceName

URL , required

Name of the audience

Request code
								
HttpResponse<String> response = Unirest.put("https://{Hostname}/applaunch/v1/apps/{applicationId}/audiences/{audienceName}") .header("appsecret", "string") .header("accept", "application/json") .body("{\"attributes\":[{\"attributeName\":\"string\",\"values\":{\"description\":\"Values of the attribute. Either \\\"in\\\" OR \\\"gt\\\" and/or \\\"lt\\\" are allowed\",\"properties\":{\"gt\":{\"description\":\"Should be either number or date type\"},\"in\":[null],\"lt\":{\"description\":\"Should be either number or date type\"}},\"type\":\"object\"}}],\"description\":\"string\"}") .asString();
Request model

description

STRING , optional

Brief description about the audience

attributes

ARRAY , optional

List of attributes for this audience

attributeName

STRING , required

Name of the attribute

values

OBJECT , required

Values of the attribute. Either "in" OR "gt" and/or "lt" are allowed

in

ARRAY , optional

Array should be of string, number, boolean or date type

gt

STRING , optional

lt

STRING , optional

Request example
{
  "description": string,
  "attributes": [{
    "attributeName": string,
    "values": {
    "in": [],
    "gt": string,
    "lt": string
  }
  }]
}
Response model

200

Successful request.

Body

name

STRING , required

Name of the audience

description

STRING , optional

Brief description about the audience

attributes [AttributesInAudienceModel]

ARRAY , required

List of attributes for this audience

attributeName

STRING , required

Name of the attribute

values

OBJECT , required

Values of the attribute. Either "in" OR "gt" and/or "lt" are allowed

in [NumberDateStringBooleanValue]

ARRAY , optional

Array should be of string, number, boolean or date type

gt

STRING , optional

lt

STRING , optional

400

Bad request.

401

Unauthorized.

404

Application/Audience doesn't exist.

Response example

200

Successful request.

								{
  "name" : string,
  "description" : string,
  "attributes" : [{
    "attributeName" : string,
    "values" : {
    "in" : [array],
    "gt" : string,
    "lt" : string
  }
  }]
}
							

400

Bad request.

401

Unauthorized.

404

Application/Audience doesn't exist.

Update an audience attribute

PUT   /apps/{applicationId}/audienceAttributes/{attributeName}

			https://applaunch.ng.bluemix.net/applaunch/v1/apps/{applicationId}/audienceAttributes/{attributeName}
		
Keys
Header parameters

appSecret

STRING , required

The appSecret associated with this application

Global variables

Hostname

STRING , required

Path and Query parameters

applicationId

URL , required

Unique ID of the application using the app launch service

attributeName

URL , required

Name of the audience attribute

Request code
								
HttpResponse<String> response = Unirest.put("https://{Hostname}/applaunch/v1/apps/{applicationId}/audienceAttributes/{attributeName}") .header("appsecret", "string") .header("accept", "application/json") .body("{\"dataType\":\"string\",\"description\":\"string\"}") .asString();
Request model

description

STRING , optional

Brief description about the attribute

dataType

STRING , optional

Data type of the attribute

Request example
{
  "description": string,
  "dataType": [string, number, date, boolean]
}
Response model

200

Successful request.

Body

name

STRING , required

Name of the attribute

description

STRING , optional

Brief description about the attribute

dataType

STRING , required

Data type of the attribute

400

Bad request.

401

Unauthorized.

404

Application doesn't exist.

Response example

200

Successful request.

								{
  "name" : string,
  "description" : string,
  "dataType" : [string, number, date, boolean]
}
							

400

Bad request.

401

Unauthorized.

404

Application doesn't exist.

Loading content...