Instabug

https://docs.instabug.com/
Admin
Instabug is an SDK providing comprehensive tools for bug reporting, crash reporting, and app...
Tokens:268,649
Snippets:2,109
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start UI Trace API

Source: https://docs.instabug.com/reference/start-ui-trace

Provides various code examples for starting a custom UI trace using the Instabug API across different platforms and languages.

```APIDOC
## Start UI Trace

### Description
Use the following APIs to start a custom UI trace while passing a `string` that defines the name of the trace.

### Method
POST (Implied by the action of starting a trace)

### Endpoint
`/websites/instabug/apm/startUITrace` (Assumed endpoint based on context)

### Parameters
#### Query Parameters
- **name** (string) - Required - The name of the UI trace to start.

### Request Example
```json
{
  "traceName": "MyCustomTrace"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation (e.g., "success").

#### Response Example
```json
{
  "status": "success"
}
```

### Code Examples

#### iOS-Swift
```swift
APM.startUITrace(withName: "name")
```

#### iOS-ObjC
```objc
[IBGAPM startUITraceWithName:@"name"];
```

#### AND-Java
```java
APM.startUITrace("name");
```

#### AND-Kotlin
```kotlin
APM.startUITrace("name")
```

#### R.N.
```javascript
APM.startUITrace("name");
```

#### Flutter
```dart
APM.startUITrace('trace_name');
```
```

--------------------------------

### Instabug SDK Usage Examples (Objective-C)

Source: https://docs.instabug.com/docs/xamarin-sdk-8-6-migration-guide

Provides Objective-C code examples for various Instabug functionalities including showing bug reports, feedback, and chats, as well as showing chat history.

```objective-c
// Compose a new bug report
[IBGBugReporting showWithReportType:IBGBugReportingReportTypeBug options:0];
// Compose new feedback
[IBGBugReporting showWithReportType:IBGBugReportingReportTypeFeedback options:0];
// Compose new chat
[IBGChats show];
// Show chat history only if the user already has a chat history. Calling this API won't have an effect otherwise.
[IBGReplies show];
```

--------------------------------

### Install Instabug Web SDK Dependencies

Source: https://docs.instabug.com/docs/web-sdk-open-source

Installs the necessary dependencies for the Instabug web SDK using Yarn. Ensure you have Yarn installed globally.

```shell
yarn install
```

--------------------------------

### Install Instabug Flutter Modular Package

Source: https://docs.instabug.com/docs/flutter-apm-screen-loading

After adding the dependency to pubspec.yaml, run 'flutter pub get' to install the instabug_flutter_modular package.

```bash
flutter pub get
```

--------------------------------

### Flutter Modular Installation

Source: https://docs.instabug.com/docs/flutter-apm-screen-loading

Steps to install the Instabug Flutter Modular package for automatic instrumentation with Flutter Modular v5.

```APIDOC
## Flutter Modular Installation

### Description
If you are using Flutter Modular v5, you need to install the `instabug_flutter_modular` package for automatic instrumentation.

### Method
N/A (Installation)

### Endpoint
N/A (Installation)

### Parameters
#### Request Body
N/A

### Request Example
1. Add `instabug_flutter_modular` to your `pubspec.yaml` file:
```yaml
dependencies:
  instabug_flutter_modular:
```

2. Install the package by running the following command:
```bash
flutter pub get
```

### Response
N/A

### Success Response (200)
N/A

### Response Example
N/A
```

--------------------------------

### Session Bucketing Logic Example

Source: https://docs.instabug.com/docs/ios-apm-app-apdex

This example demonstrates how sessions are categorized into frustrating, tolerable, and satisfying based on the percentage of specific occurrences within a session. It outlines the conditions for each category.

```text
If (frustrating% >= 30%) then Frustrating session
Else if (satisfying% >= 50%) then Satisfying session
Else Tolerable session
```

--------------------------------

### Install Instabug Package

Source: https://docs.instabug.com/docs/flutter-integration

Runs the command to fetch and install the Instabug package after adding it to pubspec.yaml.

```shell
flutter packages get
```

--------------------------------

### Webhook Integration Setup

Source: https://docs.instabug.com/docs/integrations-webhook

Instructions on how to set up a Webhook integration with Instabug, including adding a URL, selecting products, and testing the integration.

```APIDOC
## Webhook Integration Setup

### Description
Guides users through the process of setting up a Webhook integration with Instabug. This involves specifying a target URL for receiving reports, selecting which Instabug products (Bugs & Crashes, APM) to integrate with, and testing the connection to ensure data is flowing correctly. It also covers enabling automatic forwarding of reports.

### Steps
1. **Add Target URL**: Provide the URL where Instabug should forward reports.
2. **Select Products**: Choose the products (Bugs & Crashes, APM) to integrate.
3. **Test Integration**: Verify that the webhook is functioning correctly.
4. **Enable Forwarding**: Configure automatic forwarding of reports (optional, can be reconfigured).
```

--------------------------------

### Start UI Trace - Swift

Source: https://docs.instabug.com/reference/start-ui-trace

Starts a custom UI trace with a given name using the Instabug APM SDK in Swift. This function is part of the APM module and requires the SDK to be initialized.

```swift
APM.startUITrace(withName: "name")
```

--------------------------------

### Install Fastlane

Source: https://docs.instabug.com/docs/ios-symbolication

Installs the Fastlane toolset, a dependency for automating iOS and Android beta deployments. This command is run via the terminal.

```shell
gem install fastlane
```

--------------------------------

### Clone Instabug Web SDK Repository

Source: https://docs.instabug.com/docs/web-sdk-open-source

Clones the Instabug web SDK repository from GitHub to your local machine. This is the first step in the installation process.

```shell
git clone https://github.com/Instabug/instabug-websdk.git
```

--------------------------------

### Replacing Deprecated Instabug Module APIs

Source: https://docs.instabug.com/docs/cordova-migration-guide

Highlights the removal and replacement of several deprecated APIs within the main `Instabug` module. `startWithToken` and `activate` are now consolidated under `start`. Message count and notification settings are moved to the `Replies` module.

```JavaScript
// Replaced `startWithToken` and `activate` with `start`
Instabug.start(...);

// Replaced `getUnreadMessagesCount` with `Replies.getUnreadRepliesCount`
var count = Replies.getUnreadRepliesCount();

// Replaced `setChatNotificationEnabled` with `Replies.setInAppNotificationEnabled`
Replies.setInAppNotificationEnabled(...);
```

--------------------------------

### Start UI Trace - Java/Kotlin

Source: https://docs.instabug.com/reference/start-ui-trace

Starts a UI trace with a specified name using the Instabug APM SDK for Android (Java or Kotlin). This method is available within the APM class.

```java
// Start UI Trace
APM.startUITrace("name");
```

```kotlin
// Start UI Trace
APM.startUITrace("name")
```

```kotlin
APM.startUITrace("trace_name");
```

--------------------------------

### Start UI Trace - Objective-C

Source: https://docs.instabug.com/reference/start-ui-trace

Initiates a custom UI trace by providing a trace name through the Instabug APM SDK in Objective-C. Ensure the APM module is integrated and initialized.

```objectivec
[IBGAPM startUITraceWithName:@"name"];
```

--------------------------------

### Available Instabug Modules

Source: https://docs.instabug.com/docs/cordova-migration-guide

Lists the available Instabug modules and how to access them via `cordova.require` or the `window` object.

```APIDOC
## Available Instabug Modules

### Description
This table shows the available Instabug modules and their respective access methods.

### Method
N/A

### Endpoint
N/A

### Parameters

#### Available Modules
Module| Using `cordova.require` (Recommended)| Using `window`  
---|---|---
`Instabug`| `cordova.require("instabug-cordova.Instabug")`| `window.InstabugLib.Instabug`  
`BugReporting`| `cordova.require("instabug-cordova.BugReporting")`| `window.InstabugLib.BugReporting`  
`FeatureRequests`| `cordova.require("instabug-cordova.FeatureRequests")`| `window.InstabugLib.FeatureRequests`  
`Surveys`| `cordova.require("instabug-cordova.Surveys")`| `window.InstabugLib.Surveys`  
`Replies`| `cordova.require("instabug-cordova.Replies")`| `window.InstabugLib.Replies`  

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Using Promises for Instabug API Calls

Source: https://docs.instabug.com/docs/react-native-sdk-12-migration-guide

Provides an example of how to use the `await` keyword with Promises returned by Instabug SDK methods, such as `Instabug.getTags`, to handle asynchronous results.

```javascript
const tags = await Instabug.getTags();
```

--------------------------------

### Send Session URLs to Intercom (Kotlin/Java)

Source: https://docs.instabug.com/docs/android-sr-support-tools

Provides code examples for sending Instabug session replay URLs to Intercom as a logged event. This helps in tracking session replays associated with support conversations.

```kotlin
SessionReplay.getSessionReplayLink { replayLink ->
            Intercom.client().apply {
                logEvent("session-replay-url", mapOf("url" to replayLink))
                present()
            }
        }

```

```java
SessionReplay.getSessionReplayLink((replayLink) -> {
    Intercom client = Intercom.client();
    client.logEvent("session-replay-url", Collections.singletonMap("url", replayLink));
    client.present();
});

```

--------------------------------

### Initialize SDK from JavaScript

Source: https://docs.instabug.com/docs/cordova-migration-guide

Explains how to initialize the Instabug SDK entirely from JavaScript, including migrating initialization code and replacing deprecated methods.

```APIDOC
## Initialize SDK from JavaScript

### Description
Users can now initialize the Instabug SDK completely from JavaScript, eliminating the need for native code changes in Java/Kotlin files.

### Method
JavaScript

### Endpoint
N/A

### Parameters
N/A

### Request Example
```javascript
// For Cordova/Ionic apps
function onDeviceReady() {
  var Instabug = cordova.require("instabug-cordova.Instabug");
  var BugReporting = cordova.require("instabug-cordova.BugReporting");

  Instabug.start(
    'APP_TOKEN',
    function () {
    	console.log('Instabug initialized.');
    },
    function (error) {
    	console.log('Instabug could not be initialized - ' + error);
    }
  );
}

// For Ionic apps using TypeScript
import { Instabug, BugReporting } from "instabug-cordova";

Instabug.start(
    'APP_TOKEN',
    [BugReporting.invocationEvents.button],
  	function () {
    	console.log('Instabug initialized.');
    },
    function (error) {
   		console.log('Instabug could not be initialized - ' + error);
    }
);
```

### Response
N/A
```

--------------------------------

### Initialize Instabug SDK: Before v11.9.0

Source: https://docs.instabug.com/docs/react-native-sdk-12-migration-guide

Shows the old method of initializing the Instabug SDK using `Instabug.start` with an app token and invocation event.

```javascript
Instabug.start('<APP_TOKEN>', [InvocationEvent.shake]);
Instabug.setSdkDebugLogsLevel(Instabug.sdkDebugLogsLevel.sdkDebugLogsLevelVerbose);
```

--------------------------------

### Example of Session Bucketing Calculation

Source: https://docs.instabug.com/docs/flutter-apm-app-apdex

This example illustrates how sessions are bucketed into frustrating, tolerable, and satisfying categories based on metric performance within a single session and calculates the overall percentages.

```text
Frustrating count = 2 + 3 = 5
Tolerable count = 2
Satisfying count = 1 + 2 = 3
Total = 10

Frustrating% = 5 / 10 = 50%
Tolerable% = 2 / 10 = 20%
Satisfying% = 3 / 10 = 30%
```

--------------------------------

### Detailed Network Request Logging Example (Java)

Source: https://docs.instabug.com/docs/android-logging

A comprehensive example demonstrating how to make an HTTP POST request using HttpUrlConnection and then log the request details, including the URL connection, request body, and response body, using InstabugNetworkLog.

```java
@Override
protected String doInBackground(Void... params) {
    
  HttpURLConnection urlConnection = null;
  BufferedReader reader = null;
  String moviesJsonStr = null;
    
  try {
    URL url = new URL("<YOUR_URL>");
    urlConnection = (HttpURLConnection) url.openConnection();
    urlConnection.setDoOutput(true);
    urlConnection.setRequestMethod("POST");        
    urlConnection.setUseCaches(false);           
    urlConnection.setConnectTimeout(10000);            
    urlConnection.setReadTimeout(10000);           
    urlConnection.setRequestProperty("Content-Type", "application/json");         
    urlConnection.connect();
    
    JSONObject jsonParam = new JSONObject();         
    try {        
      jsonParam.put("PARAM_1", "one");           
      jsonParam.put("PARAM_2", "two");       
    } catch (JSONException e) {            
      e.printStackTrace();        
    }
        
    OutputStreamWriter out = new OutputStreamWriter(urlConnection.getOutputStream());
    out.write(jsonParam.toString());   
    out.close();

    InputStream inputStream = urlConnection.getInputStream();
    StringBuffer buffer = new StringBuffer();
    if (inputStream == null) {
        return null;
    }
                
    reader = new BufferedReader(new InputStreamReader(inputStream));              
    String line;
    while ((line = reader.readLine()) != null) {
      buffer.append(line + "\n");   
    }
        
    if (buffer.length() == 0) {                 
      // Stream was empty.  No point in parsing.             
      return null;      
    }
    moviesJsonStr = buffer.toString();

    //logging network request to instabug
    InstabugNetworkLog networkLog = new InstabugNetworkLog();
    networkLog.Log(urlConnection, jsonParam.toString(), moviesJsonStr);

  } catch(Exception e) {
    e.printStackTrace();
  }
  return moviesJsonStr;
}

```

--------------------------------

### Start Instabug with Invocation Events (Swift)

Source: https://docs.instabug.com/docs/ios-invocation

Starts the Instabug SDK with specified invocation events. The token is required for SDK initialization. Invocation events determine how the SDK is triggered.

```Swift
Instabug.start(withToken: "YOUR-TOKEN-HERE", invocationEvents: [.shake, .screenshot])
```

--------------------------------

### Migrate Initialization Code to JS

Source: https://docs.instabug.com/docs/cordova-migration-guide

Provides steps to migrate existing initialization code to JavaScript, including modifying AndroidManifest.xml and replacing `Instabug.activate` with `Instabug.start`.

```APIDOC
## Migrate Initialization Code to JS

### Description
This section details the steps to migrate your Instabug SDK initialization code to JavaScript.

### Method
JavaScript & XML

### Endpoint
N/A

### Steps
1. **Remove `AndroidManifest.xml` attribute**: If `platform/android` is in your source control, remove the following attribute from `platforms/android/app/src/main/AndroidManifest.xml`:
   ```xml
   android:name="com.instabug.cordova.plugin.MyApplication"
   ```
2. **Initialize Instabug in JS**: Replace calls for `Instabug.activate` with `Instabug.start` inside your `onDeviceReady` function. Refer to the JavaScript examples provided in the "Initialize SDK from JavaScript" section.
3. **Replace `Instabug.activate` options**: Use the alternative JS API for options previously used with `Instabug.activate`:

Key| Alternative JS API  
---|---
`shakingThresholdIPhone`| `BugReporting.setShakingThresholdForiPhone`  
`shakingThresholdIPad`| `BugReporting.setShakingThresholdForiPad`  
`floatingButtonEdge`
`floatingButtonOffset`| `BugReporting.setFloatingButtonEdge`  
`enableSessionProfiler`| `Instabug.setSessionProfilerEnabled`  
`colorTheme`| `Instabug.setColorTheme`  
`welcomeMessageMode`| `Instabug.setWelcomeMessageMode`  

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Migrating IBGAPM App Launch Enabled

Source: https://docs.instabug.com/docs/ios-sdk-12-migration-guide

This snippet illustrates the change in handling app launch tracking for `IBGAPM`. The `appLaunchEnabled` property is now accessed via `IBGAPM.coldAppLaunchEnabled`.

```objective-c
IBGAPM.coldAppLaunchEnabled
```

--------------------------------

### Instabug General API Migration

Source: https://docs.instabug.com/docs/android-sdk-12-migration-guide

Covers migration for general Instabug settings. setDebugEnabled is now handled by setSdkDebugLogsLevel, and reproStepsState configurations are managed through setReproConfigurations.

```java
Instabug| setDebugEnabled(final boolean isDebugEnabled)| setSdkDebugLogsLevel(@LogLevel final int level)
```

```java
Instabug| setReproStepsState(final State reproStepsState)| setReproConfigurations(ReproConfigurations configurations)
```

```java
Instabug.Builder| setReproStepsState(State state)| setReproConfigurations(ReproConfigurations configurations)
```

```java
Instabug.Builder| setDebugEnabled(final boolean isDebugEnabled)| setReproConfigurations(ReproConfigurations configurations)
```

--------------------------------

### Session Bucketing Criteria Example

Source: https://docs.instabug.com/docs/flutter-apm-app-apdex

This example demonstrates the criteria used to classify a session as frustrating, satisfying, or tolerable based on calculated percentages of frustrating and satisfying metrics.

```text
Frustrating session if frustrating% >= 30%
Otherwise, satisfying session if satisfying% >= 50%
Otherwise, tolerable session
```

--------------------------------

### Configure Expo Start for Custom Development Client

Source: https://docs.instabug.com/docs/react-native-expo-integration

Modifies package.json scripts to use the --dev-client flag for the start command when using a custom development client for older Expo managed workflows.

```json
"scripts": {
  "start": "expo start --dev-client",
  "android": "expo run:android",
  "ios": "expo run:ios"
}
```

--------------------------------

### Start Instabug with Invocation Events (Objective-C)

Source: https://docs.instabug.com/docs/ios-invocation

Starts the Instabug SDK with specified invocation events using Objective-C syntax. A unique token is necessary for initialization, and event flags control SDK triggering.

```Objective-C
[Instabug startWithToken:@"YOUR-TOKEN-HERE" invocationEvents: IBGInvocationEventShake | IBGInvocationEventScreenshot];
```

--------------------------------

### Pushing a Named Route

Source: https://docs.instabug.com/docs/flutter-apm-screen-loading

Example of pushing a named route to the navigation stack after setting up instrumentation.

```APIDOC
## Pushing a Named Route

### Description
After configuring Navigator 1.0 instrumentation, screen loading times are captured automatically when you push a route to the navigation stack.

### Method
N/A (Usage)

### Endpoint
N/A (Usage)

### Parameters
N/A

### Request Example
```dart
Navigator.pushNamed(context,"/settings");
```

### Response
N/A

### Success Response (200)
N/A

### Response Example
N/A
```

--------------------------------

### Start a Flow

Source: https://docs.instabug.com/docs/react-native-app-flows

Initiates an instance of a named flow. If other instances of the same flow are already running, they are marked as drop-offs.

```APIDOC
## POST /api/flows/start

### Description
Initiates an instance of a flow with a given name. This marks the beginning of a user journey.

### Method
POST

### Endpoint
/api/flows/start

### Parameters
#### Query Parameters
- **flowName** (string) - Required - The name of the flow to start. Flow names have limitations: up to 150 characters, cannot be null or empty, and should avoid special characters like [, (, ), =, {, }, <, >, /, \ which will be replaced by underscores.

### Request Example
```javascript
APM.startFlow("flowName");
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the flow has started.

#### Response Example
```json
{
  "message": "Flow 'flowName' started successfully."
}
```
```

--------------------------------

### Importing Instabug Modules

Source: https://docs.instabug.com/docs/cordova-migration-guide

Demonstrates the new way to import Instabug modules using `cordova.require` or the `window` object, replacing the older polluting method.

```APIDOC
## Importing Instabug Modules

### Description
Prior to v11, Instabug modules were polluting the `plugins` object. Now, you can use `cordova.require` for a cleaner approach.

### Method
JavaScript (using `cordova.require` or `window`)

### Endpoint
N/A

### Parameters
N/A

### Request Example
```javascript
// Using cordova.require (Recommended)
var BugReporting = cordova.require("instabug-cordova.BugReporting");
BugReporting.setEnabled(...);

// Using window object
var BugReporting = window.InstabugLib.BugReporting;
```

### Response
N/A
```

--------------------------------

### React Navigation v6 Setup with Instabug

Source: https://docs.instabug.com/docs/react-native-repro-steps

Integrates Instabug with React Navigation v6 by using `navigationRef` and `Instabug.setNavigationListener`. This setup captures navigation events for repro steps. It requires the `useNavigationContainerRef` hook from '@react-navigation/native'.

```javascript
const navigationRef = useNavigationContainerRef();
  useEffect(() => {
    const unregisterListener = Instabug.setNavigationListener(navigationRef);
    return unregisterListener;
  }, [navigationRef]);
```

```jsx
<NavigationContainer  ref={navigationRef}>
            <RootTabNavigator /> // add navigation Ref to  NavigationContainer
  ...
</ NavigationContainer>
```

--------------------------------

### Install Instabug Fastlane Plugin

Source: https://docs.instabug.com/docs/ios-symbolication

Adds the official Instabug plugin to your Fastlane setup, enabling integration with Instabug services for dSYM uploads and other features.

```ruby
fastlane add_plugin instabug_official
```

--------------------------------

### APM API Changes

Source: https://docs.instabug.com/docs/android-sdk-12-migration-guide

This section details changes within the APM module, specifically for app launch and log level settings.

```APIDOC
## APM API Changes

### Description
Updates to APM settings for app launch and log levels.

### Method
N/A (Configuration changes)

### Endpoint
N/A

### Parameters
#### Deprecated API
- **setAppLaunchEnabled** (boolean) - Replaced by `setColdAppLaunchEnabled`.
- **setLogLevel** (`@LogLevel int level`) - Replaced by `Instabug.setSdkDebugLogsLevel`.

#### Corresponding API
- **setColdAppLaunchEnabled** (boolean) - Enables or disables cold app launch tracking.
- **Instabug.setSdkDebugLogsLevel** (`@LogLevel int level`) - Sets the SDK's debug log level.
```

--------------------------------

### Enable/Set Chats State (iOS/Android)

Source: https://docs.instabug.com/docs/xamarin-sdk-8-6-migration-guide

Illustrates how to enable or disable chat features. The iOS 'IBGChats.Enabled' property is replaced by InstabugCore.SetChatsState for Android, with separate code examples for each platform.

```ios
IBGChats.Enabled = false;
```

```android
InstabugCore.SetChatsState(Feature.State.Disabled)
```

--------------------------------

### Initialize SDK with Legacy CodePush Version

Source: https://docs.instabug.com/docs/over-the-air-updates

Demonstrates the deprecated method of initializing the Instabug SDK with the `codePushVersion` parameter for older integrations.

```APIDOC
## POST /init/legacy-codepush

### Description
Initializes the Instabug SDK with the legacy `codePushVersion` parameter. This method is deprecated but still supported for backward compatibility.

### Method
POST

### Endpoint
N/A (This is a client-side SDK initialization)

### Parameters
#### Request Body
- **token** (string) - Required - Your Instabug application token.
- **codePushVersion** (string) - Required (Deprecated) - The version identifier for CodePush.
- **invocationEvents** (array) - Optional - Events that trigger the Instabug SDK (e.g., `InvocationEvent.shake`).

### Request Example
```json
{
  "token": "<User-App-token>",
  "codePushVersion": "<Code-push-version>",
  "invocationEvents": ["shake"]
}
```

### Response
#### Success Response (200)
SDK initialized successfully.

#### Response Example
N/A
```

--------------------------------

### Build Instabug Web SDK

Source: https://docs.instabug.com/docs/web-sdk-open-source

Builds the Instabug web SDK project. This command compiles the source code into a distributable format.

```shell
yarn build
```

--------------------------------

### Send Session Replay URL to Intercom in Flutter

Source: https://docs.instabug.com/docs/flutter-sr-support-tools

This example demonstrates how to get the session replay link and send it as a custom event to Intercom in a Flutter app. It handles the case where the link might be null and logs the event with the URL.

```dart
final result = await SessionReplay.getSessionReplayLink();
    if (result != null) {
      await Intercom.instance.loginUnidentifiedUser();
      await Intercom.instance.logEvent('session-replay-url', {"url": result});
    }
```

--------------------------------

### Remove Android Initialization Code (Java)

Source: https://docs.instabug.com/docs/flutter-migration-guide

This snippet shows how to remove the previous Android-specific Instabug SDK initialization code from the `CustomFlutterApplication.java` file. It involves commenting out lines that manually started the Instabug Flutter plugin.

```java
    // Remove these lines from android/app/src/main/java/<your_package>/CustomFlutterApplication.java
    // ArrayList<String> invocationEvents = new ArrayList<>();
    // invocationEvents.add(InstabugFlutterPlugin.INVOCATION_EVENT_SHAKE);
    // new InstabugFlutterPlugin().start(CustomFlutterApplication.this, "APP_TOKEN", invocationEvents);
```

--------------------------------

### Instabug SDK: Setting Repro Configurations (Java)

Source: https://docs.instabug.com/docs/android-repro-steps

Applies the configured Repro Configurations to the Instabug SDK in Java. This allows developers to set how Repro Steps are captured, either during initial build or dynamically at runtime.

```java
//build time
new Instabug.Builder(this, "{INSTABUG_TOKEN}")
                .setReproConfigurations(configurations)
                .build();
//runtime 
Instabug.setReproConfigurations(configurations);
```

--------------------------------

### SDK Initialization

Source: https://docs.instabug.com/docs/web-sdk-open-source

Initializes the Instabug Web SDK with provided configuration options. This makes the Instabug button visible on the UI.

```APIDOC
## .init(options)

### Description
Initializes the SDK. When called, the Instabug button should become visible in your UI.

### Method
`init`

### Parameters
`options`: `Object` - Required.
  * `zapierWebhookUrl`: (String) - The webhook URL obtained from Zapier for integrating with other tools.
  * `cloudinaryCloudName`: (String) - Your Cloudinary cloud name, found on your Cloudinary dashboard.
  * `cloudinaryUploadPreset`: (String) - Your Cloudinary upload preset name, configured in your Cloudinary settings.

### Request Example
```javascript
ibgSdk.init({
  zapierWebhookUrl: 'ZAPIER_WEBHOOK_URL',
  cloudinaryCloudName: 'CLOUDINARY_CLOUND_NAME',
  cloudinaryUploadPreset: 'CLOUDINARY_UPLOAD_PRESET',
});
```
```

--------------------------------

### User Interaction Tracking Example

Source: https://docs.instabug.com/docs/ios-swiftui-integration-script

Shows how the InstabugSwiftUIIntegrator enhances user interaction callbacks, such as button taps, by injecting tracking code using `UserStep`.

```SWIFT
// Original code
Button("Submit") {
    submitForm()
}

// After instrumentation
Button("Submit") {
    UserStep(event: .tap, automatic: true)?
        .setViewTypeName("Button")
        .setMessage("Tap on Button Submit")
        .logUserStep()
    submitForm()
}
```

--------------------------------

### Upload Mapping Files Script (Shell)

Source: https://docs.instabug.com/docs/android-obfuscation

Shell script to upload mapping files to Instabug. It requires setting the app token and path to the mapping file, then uses curl to send a POST request to the Instabug API.  Ensure curl is installed and the correct paths/tokens are configured.

```shell
#!/bin/bash
echo "Instabug mapping files uploader"

# Constants for app token and mapping files
APP_TOKEN="APPTOKEN"
PATH_TO_MAPPING_FILE="PATH/TO/FILE.txt"
VERSION_CODE="1"
VERSION_NAME="1.1"
VERSION='{"code":"'"$VERSION_CODE"'","name":"'"$VERSION_NAME"'"}'

if [ ! -f $PATH_TO_MAPPING_FILE ]; then
    echo "File not found!"
    exit 0
fi

echo "Mapping file found! Uploading..."

ENDPOINT="https://api.instabug.com/api/sdk/v3/symbols_files"
STATUS=$(curl "${ENDPOINT}" --write-out %{http_code} --silent --output /dev/null -F os=android -F app_version="${VERSION}" -F symbols_file=@"${PATH_TO_MAPPING_FILE}" -F application_token="${APP_TOKEN}")
if [ $STATUS -ne 200 ]; then
  echo "Error while uploading mapping files"
  exit 0
fi


echo "Success! Your mapping files got uploaded successfully"

```

--------------------------------

### Initialize Instabug SDK

Source: https://docs.instabug.com/docs/web-sdk-open-source

Initializes the Instabug web SDK with required configuration options. You need to provide your Zapier webhook URL, Cloudinary cloud name, and upload preset.

```javascript
ibgSdk.init({
  zapierWebhookUrl: 'ZAPIER_WEBHOOK_URL',
  cloudinaryCloudName: 'CLOUDINARY_CLOUND_NAME',
  cloudinaryUploadPreset: 'CLOUDINARY_UPLOAD_PRESET',
});
```

--------------------------------

### Manually Start New Chat via API (JavaScript)

Source: https://docs.instabug.com/docs/cordova-chat-workflow

This API allows you to directly display a new chat page to the user, composing a new chat immediately. It is equivalent to the 'Ask a Question' button functionality. Ensure the Instabug chat plugin is correctly installed and configured.

```javascript
cordova.plugins.chats.show(boolean, successCb, errorCb)
```

--------------------------------

### Navigate to Instabug Web SDK Directory

Source: https://docs.instabug.com/docs/web-sdk-open-source

Changes the current directory to the cloned Instabug web SDK folder. This is necessary to run subsequent installation and build commands.

```shell
cd instabug-websdk
```

--------------------------------

### Display Help and Version Information

Source: https://docs.instabug.com/docs/ios-swiftui-integration-script

Commands to display help and version information for the InstabugSwiftUIIntegrator tool. These commands are essential for understanding the tool's capabilities and current version.

```bash
# Display help information
InstabugSwiftUIIntegrator --help

# Display version information
InstabugSwiftUIIntegrator --version
```

--------------------------------

### Instabug Core API Changes

Source: https://docs.instabug.com/docs/android-sdk-12-migration-guide

This section details changes in the core Instabug SDK functionalities, including debug mode and repro steps.

```APIDOC
## Instabug Core API Changes

### Description
Updates to core Instabug SDK settings for debugging and repro steps configuration.

### Method
N/A (Method and Builder changes)

### Endpoint
N/A

### Parameters
#### Deprecated API
- **Instabug.setDebugEnabled** (boolean `isDebugEnabled`)
- **Instabug.setReproStepsState** (`State reproStepsState`)
- **Instabug.Builder.setReproStepsState** (`State state`)
- **Instabug.Builder.setDebugEnabled** (boolean `isDebugEnabled`)

#### Corresponding API
- **Instabug.setSdkDebugLogsLevel** (`@LogLevel int level`) - Sets the SDK's debug log level.
- **Instabug.setReproConfigurations** (`ReproConfigurations configurations`) - Configures repro steps and related settings.
- **Instabug.Builder.setReproConfigurations** (`ReproConfigurations configurations`) - Builder method to configure repro steps.
```

--------------------------------

### Instabug SDK: Setting Repro Configurations (Kotlin)

Source: https://docs.instabug.com/docs/android-repro-steps

Applies the configured Repro Configurations to the Instabug SDK. This can be done during the SDK build process or at runtime to manage how Repro Steps are captured.

```kotlin
//build time
Instabug.Builder(this, "{INSTABUG_TOKEN}")
    .setReproConfigurations(configurations)
    .build()

//runtime
Instabug.setReproConfigurations(configurations)
```

--------------------------------

### Install Instabug SDK with npm or Yarn

Source: https://docs.instabug.com/docs/react-native-expo-integration

Installs the Instabug SDK for React Native. This is the first step in integrating Instabug into your Expo project.

```shell
npm install instabug-reactnative
```

```shell
yarn add instabug-reactnative
```

--------------------------------

### Initialize Instabug SDK (Flutter)

Source: https://docs.instabug.com/docs/flutter-sdk-12-migration-guide

This snippet demonstrates how to initialize the Instabug SDK in a Flutter application, showing the old method using `Instabug.start` and the new method `Instabug.init` with updated parameters.

```flutter
Instabug.start('<APP_TOKEN>', [InvocationEvent.shake]);
Instabug.setSdkDebugLogsLevel(LogLevel.verbose);
```

```flutter
Instabug.init(
  token: '<APP_TOKEN>',
  invocationEvents: [InvocationEvent.shake],
  debugLogsLevel: LogLevel.verbose,
);
```

--------------------------------

### Install Instabug Cordova Plugin

Source: https://docs.instabug.com/docs/cordova-integration

Command to install the Instabug Cordova plugin. This is the first step in integrating Instabug into your Cordova or Ionic projects.

```shell
cordova plugin add instabug-cordova
```

```shell
ionic cordova plugin add instabug-cordova
```

--------------------------------

### Start a Flow - Swift

Source: https://docs.instabug.com/docs/ios-app-flows

Initiates an instance of a flow with a given name in Swift. If previous instances of the same flow exist without being ended, they are marked as drop-offs. Flow names have limitations on length and character usage.

```swift
//Start a Flow
APM.startFlow(withName: "flow-name")
```

--------------------------------

### Start a Flow

Source: https://docs.instabug.com/docs/ios-app-flows

This API call initiates an instance of a flow named 'flowName'. If any other instances of the same flow are already started and haven’t ended yet, they are considered drop-offs.

```APIDOC
## Start a Flow

### Description
Initiates an instance of a flow with a specified name. If other instances of the same flow are active, they are marked as drop-offs.

### Method
APM.startFlow(withName:)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```swift
// Swift
APM.startFlow(withName: "flow-name")
```
```objectivec
// Objective-C
[IBGAPM startFlowWithName:@"flow-name"];
```

### Response
#### Success Response (200)
No explicit response, operation is handled by the SDK.

#### Response Example
N/A
```

--------------------------------

### Initialize Instabug SDK: After v11.9.0

Source: https://docs.instabug.com/docs/react-native-sdk-12-migration-guide

Demonstrates the new method for initializing the Instabug SDK using `Instabug.init` with a configuration object, including token, invocation events, and debug log level.

```javascript
Instabug.init({
  token: '<APP_TOKEN>',
  invocationEvents: [InvocationEvent.shake],
  debugLogsLevel: LogLevel.verbose,
});
```

--------------------------------

### Get Available Surveys (Flutter)

Source: https://docs.instabug.com/reference/check-for-available-surveys

Retrieves all available surveys within a Flutter application. This method call returns the survey titles.

```dart
final titles = Surveys.getAvailableSurveys();
```

--------------------------------

### Get Available Surveys (Android-Kotlin)

Source: https://docs.instabug.com/reference/check-for-available-surveys

Retrieves all available surveys using Kotlin for Android. This is a straightforward method call within the Instabug SDK.

```kotlin
Surveys.getAvailableSurveys()
```

--------------------------------

### Show Bug/Chat (C#)

Source: https://docs.instabug.com/docs/xamarin-sdk-8-6-migration-guide

Demonstrates the change in how to show bug reports or chats. The previous IBGChats.Show() is replaced by IBGBugReporting.ShowWithReportType with specific report types and options.

```csharp
IBGChats.Show();
```

```csharp
IBGBugReporting.ShowWithReportType(IBGBugReportingReportType.Question, IBGBugReportingOption.EmailFieldHidden);
```

--------------------------------

### Get Available Surveys (Android-Java)

Source: https://docs.instabug.com/reference/check-for-available-surveys

Obtains all available surveys using Java for Android. This method is a direct call within the Surveys SDK.

```java
Surveys.getAvailableSurveys();
```

--------------------------------

### Include Instabug SDK in HTML

Source: https://docs.instabug.com/docs/web-sdk-open-source

Includes the built Instabug SDK JavaScript file into your web page's HTML. Replace '/PATH/TO/' with the actual path to the `instabug-sdk.min.js` file.

```html
<script src="/PATH/TO/instabug-sdk.min.js"></script>
```

--------------------------------

### Repro Steps Configuration

Source: https://docs.instabug.com/docs/android-repro-steps

Configure the behavior of Repro Steps, including issue modes and screenshot inclusion for different Instabug features.

```APIDOC
## Repro Steps Configuration

### Description
Configures how Repro Steps are captured and included for Bug Reporting, Crash Reporting, and Session Replay.

### Method
SDK Configuration

### Parameters
#### ReproConfigurations
- **issueMode** (ReproConfigurations.IssueMode) - Required - Defines the issue type and whether screenshots are included.
  - `IssueType.All`: Applies to Bug Reporting, Crash Reporting, and Session Replay.
  - `IssueType.Bug`: Applies only to Bug Reporting.
  - `IssueType.Crash`: Applies only to Crash Reporting.
  - `IssueType.SessionReplay`: Applies only to Session Replay.
- **reproMode** (ReproConfigurations.ReproMode) - Required - Defines the mode for capturing repro steps.
  - `ReproMode.EnableWithScreenshots`: Enables repro steps with screenshots.
  - `ReproMode.EnableWithNoScreenshots`: Enables repro steps without screenshots.
  - `ReproMode.Disable`: Disables repro steps.

### Request Example
```kotlin
val configurations = ReproConfigurations.Builder()
  .setIssueMode(IssueType.All, ReproMode.EnableWithScreenshots)
  .build()

Instabug.setReproConfigurations(configurations)
```
```java
ReproConfigurations configurations = new ReproConfigurations.Builder()
                .setIssueMode(IssueType.All, ReproMode.EnableWithScreenshots)
                .build();

Instabug.setReproConfigurations(configurations);
```

### Notes
- Repro Steps are enabled by default with screenshots for bug reporting and session replay, and enabled without screenshots for crash reporting.
```

--------------------------------

### Get Available Surveys (iOS-Objective-C)

Source: https://docs.instabug.com/reference/check-for-available-surveys

Fetches all available surveys using Objective-C. This method utilizes a completion handler to return an array of IBGSurvey objects.

```objective-c
[IBGSurveys availableSurveysWithCompletionHandler: ^(NSArray<IBGSurvey *> *validSurveys) {
        
    }];
```

--------------------------------

### Start a Flow

Source: https://docs.instabug.com/docs/android-app-flows

This API call initiates an instance of a flow named "flowName". If any other instances of the same flow are already started and weren’t ended yet, they are considered drop-offs.

```APIDOC
## Start a Flow

### Description
To mark the **beginning of a Flow**, add the following API call to your code.

### Method
`APM.startFlow()`

### Endpoint
Not Applicable (SDK Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```kotlin
//Start a Flow
APM.startFlow("flowName")
```

```java
//Start a Flow
APM.startFlow("flowName");
```

### Response
#### Success Response (200)
None (This is an SDK method)

#### Response Example
None

### Notes
- Flow **name** can be up to **150 characters**. Any extra characters are truncated.
- Flow **name can't be null** or an **empty string**.
- **Avoid** adding any of these **special characters** [, (, ), =, {, }, <, >, /, \] (commas not included) as they will be replaced with _.
```

--------------------------------

### Initialize SDK with CodePush OTA Version (Deprecated)

Source: https://docs.instabug.com/docs/over-the-air-updates

Initializes the Instabug SDK with the deprecated `codePushVersion` parameter for tracking CodePush updates. This method is supported but the unified `setOverAirVersion` API is recommended.

```javascript
// Deprecated but still supported
Instabug.init({
  token: '<User-App-token>',
  codePushVersion: '<Code-push-version>',
  invocationEvents: [<Invocation-events>],
});

```
Tokens:
Raw