Introduction

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

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 and 201 response always indicates success. A 202 response indicates request is accepted sucessfully. A 400 type response is some sort of failure, and a 500 type response usually indicates an internal system error.

Methods

Create a feature

POST /apps/{applicationId}/features
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

  • Conflict.

Example responses

Update a feature

PUT /apps/{applicationId}/features/{featureName}
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the feature

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Get a feature

GET /apps/{applicationId}/features/{featureName}
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the feature

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application/feature doesn't exist.

Example responses

Delete a feature

DELETE /apps/{applicationId}/features/{featureName}
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the feature

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application/feature doesn't exist.

Example responses

Create an inApp message

POST /apps/{applicationId}/inApp
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

  • Conflict.

Example responses

Update an inApp message

PUT /apps/{applicationId}/inApp/{messageName}
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the message

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Get an inApp message

GET /apps/{applicationId}/inApp/{messageName}
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the message

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application/feature doesn't exist.

Example responses

Delete an inApp message

DELETE /apps/{applicationId}/inApp/{messageName}
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the message

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application/feature doesn't exist.

Example responses

Create an audience

POST /apps/{applicationId}/audiences
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Get an audience

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

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the audience

Response

Status Code

  • Successful request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Update an audience

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

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the audience

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application/Audience doesn't exist.

Example responses

Delete an audience

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

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the audience

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Create an audience attribute

POST /apps/{applicationId}/audienceAttributes
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

  • Conflict.

Example responses

Update an audience attribute

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

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the audience attribute

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Get an audience attribute

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

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the audience attribute

Response

Status Code

  • Successful request.

  • Unauthorized.

  • Application/Attribute doesn't exist.

Example responses

Delete an audience attribute

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

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the audience attribute

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application/Attribute doesn't exist.

Example responses

Create a feature engagement

POST /apps/{applicationId}/engagements/feature
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application/Engagament doesn't exist.

  • Conflict.

Example responses

Update a feature engagement

PUT /apps/{applicationId}/engagements/feature/{engagementName}
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the engagement

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application/Engagement doesn't exist.

  • Conflict.

Example responses

Get a feature engagement

GET /apps/{applicationId}/engagements/feature/{engagementName}
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the engagement

Response

Status Code

  • Successful request.

  • Unauthorized.

  • Application/FeatureEngagement doesn't exist.

Example responses

Delete a feature engagement

DELETE /apps/{applicationId}/engagements/feature/{engagementName}
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the engagement

Response

Status Code

  • Successful request.

  • Unauthorized.

  • Application/FeatureEngagement doesn't exist.

Example responses

Create an inApp message engagement

POST /apps/{applicationId}/engagements/inApp
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Update an inApp message engagement

PUT /apps/{applicationId}/engagements/inApp/{engagementName}
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the engagement

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Get an inApp message engagement

GET /apps/{applicationId}/engagements/inApp/{engagementName}
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the engagement

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Delete an inApp message engagement

DELETE /apps/{applicationId}/engagements/inApp/{engagementName}
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the engagement

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Get the actions

GET /apps/{applicationId}/devices/{deviceId}/actions
Request

Custom Headers

  • The clientSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Unique identifier of the device

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Send metric code

POST /apps/{applicationId}/devices/{deviceId}/events/metrics
Request

Custom Headers

  • The clientSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Unique identifier of the device

Response

Status Code

  • Request accepted.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Send session event

POST /apps/{applicationId}/devices/{deviceId}/events/sessionActivity
Request

Custom Headers

  • The clientSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Unique identifier of the device

Response

Status Code

  • Request accepted.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Create device registration

POST /apps/{applicationId}/devices
Request

Custom Headers

  • The clientSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

Response

Status Code

  • Request accepted.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Update device registration

PUT /apps/{applicationId}/devices/{deviceId}
Request

Custom Headers

  • The clientSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Unique identifier of the device

Response

Status Code

  • Request accepted.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Delete device registration

DELETE /apps/{applicationId}/devices/{deviceId}
Request

Custom Headers

  • The clientSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Unique identifier of the device

Response

Status Code

  • Request accepted.

  • Bad request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Get insights on application

GET /apps/{applicationId}/insights
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

Response

Status Code

  • Successful request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Get insights on all engagements

GET /apps/{applicationId}/insights/engagements
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

Response

Status Code

  • Successful request.

  • Unauthorized.

  • Application doesn't exist.

Example responses

Get insights on feature engagement

GET /apps/{applicationId}/insights/engagements/feature/{engagementName}
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the engagement

Response

Status Code

  • Successful request.

  • Unauthorized.

  • Application/Engagement doesn't exist.

Example responses

Get insights on inApp engagement

GET /apps/{applicationId}/insights/engagements/inApp/{engagementName}
Request

Custom Headers

  • The appSecret associated with this application

Path Parameters

  • Unique ID of the application using the app launch service

  • Name of the engagement

Response

Status Code

  • Successful request.

  • Bad request.

  • Unauthorized.

  • Application/Engagement doesn't exist.

Example responses