Shake

https://docs.shakebugs.com/docs/
Admin
Shake is a multi-platform feedback and bug reporting SDK that enables developers to gather user...
Tokens:199,487
Snippets:1,787
Trust Score:9.5
Update:16 hours ago
Show doc for...
Tokens:
Raw
### Example Response for GET /accounts/members

Source: https://docs.shakebugs.com/docs/rest-api/modules/accounts

Example JSON response showing two team members with their user details and roles.

```json
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "user": {
      "id": "660e8400-e29b-41d4-a716-446655440000",
      "email": "john.doe@example.com",
      "name": "John Doe",
      "picture": "https://example.com/avatar.jpg"
    },
    "role": "admin"
  },
  {
    "id": "770e8400-e29b-41d4-a716-446655440000",
    "user": {
      "id": "880e8400-e29b-41d4-a716-446655440000",
      "email": "jane.smith@example.com",
      "name": "Jane Smith",
      "picture": "https://example.com/avatar2.jpg"
    },
    "role": "member"
  }
]
```

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

### Example Request for GET /accounts/members

Source: https://docs.shakebugs.com/docs/rest-api/modules/accounts

Example curl command to retrieve team members. Requires a valid REST API key in the X-API-KEY header.

```bash
curl -H "X-API-KEY: your_rest_api_key_here" \
  https://dashboard-api.shakebugs.com/api/rest/accounts/members
```

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

### Get Activity Logs - curl Example

Source: https://docs.shakebugs.com/docs/rest-api/modules/user-feedback

Example curl command to retrieve activity logs. Requires an API key in the X-API-KEY header.

```bash
curl -H "X-API-KEY: your_rest_api_key_here" \
  https://dashboard-api.shakebugs.com/api/rest/issue_tracking/issues/550e8400-e29b-41d4-a716-446655440000/logs
```

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

### Example Request for OPTIONS /accounts/members

Source: https://docs.shakebugs.com/docs/rest-api/modules/accounts

Example curl command to check allowed methods. Requires a valid REST API key in the X-API-KEY header.

```bash
curl -X OPTIONS -H "X-API-KEY: your_rest_api_key_here" \
  https://dashboard-api.shakebugs.com/api/rest/accounts/members
```

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

### Example Request with curl

Source: https://docs.shakebugs.com/docs/rest-api/overview

Example curl command to fetch crash groups, using the X-API-KEY header.

```bash
curl -H "X-API-KEY: your_rest_api_key_here" \
  https://dashboard-api.shakebugs.com/api/rest/crash_reporting/crash_groups
```

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

### Get user feedback details - JSON response

Source: https://docs.shakebugs.com/docs/rest-api/modules/user-feedback

Example response for the get user feedback details endpoint. Includes device, environment, permissions, and user context.

```json
{
  "id": "uuid",
  "key": 42,
  "app_id": "uuid",
  "title": "Login button not working",
  "issue_reported_time": "2024-01-01T10:30:00Z",
  "device": "iPhone 13 Pro",
  "os_name": "iOS",
  "os_version": "16.0",
  "app_version": "2.1.0",
  "build_version": "210",
  "sdk_version": "15.1.0",
  "locale": "en_US",
  "timezone": "America/New_York",
  "battery_level": 0.75,
  "battery_status": 2,
  "available_memory": 4096000000,
  "used_memory": 2048000000,
  "network_type": "wifi",
  "screenshot_url": "https://...",
  "video_url": "https://...",
  "session_replay_url": "https://...",
  "public_url": "https://...",
  "permalink": "https://...",
  "status": {
    "status": "New",
    "updated": "2024-01-01T10:30:00Z"
  },
  "priority": {
    "priority": "high",
    "updated": "2024-01-01T10:30:00Z"
  },
  "assignee": {
    "assignee_id": "uuid",
    "name": "John Doe",
    "email": "john@example.com",
    "updated": "2024-01-01T11:00:00Z"
  },
  "tags": ["bug"],
  "permissions": [
    {
      "id": "uuid",
      "name": "camera",
      "state": "granted",
      "created": "2024-01-01T10:30:00Z"
    }
  ],
  "app_user": {
    "id": "uuid",
    "end_user_id": "user@example.com",
    "metadata_": {},
    "banned": false,
    "city": "New York",
    "country": "United States"
  },
  "custom_fields": [
    {
      "type": "string",
      "label": "User Role",
      "value": "Premium"
    }
  ]
}
```

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

### Install Shake with Expo

Source: https://docs.shakebugs.com/docs/react/installation

Recommended way to install packages when using Expo. Note that Shake is not supported in Expo Go; you need to set up development builds.

```bash
npx expo install @shakebugs/react-native-shake
```

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

### Example Response Headers

Source: https://docs.shakebugs.com/docs/rest-api/overview

Example rate limit headers returned in API responses.

```text
x-ratelimit-limit: 200
x-ratelimit-remaining: 199
x-ratelimit-reset: 1767826558
```

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

### Install CocoaPods dependencies

Source: https://docs.shakebugs.com/docs/react/installation

Run this command from the project root directory to install iOS pods. After installation, also run 'pod update Shake' to ensure you're using the latest Shake version.

```bash
cd ios && pod install && cd ..
```

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

### Install Shake fastlane plugin

Source: https://docs.shakebugs.com/docs/ios/crash-reports/symbolicate

Run this command in the terminal to install the Shake plugin for fastlane. It adds the 'upload_symbols_to_shake' action.

```ruby
bundle exec fastlane add_plugin upload_symbols_to_shake
```

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

### Install Shake with npm (React Native CLI)

Source: https://docs.shakebugs.com/docs/react/installation

Run this command in your terminal to install the @shakebugs/react-native-shake package using npm.

```bash
npm install @shakebugs/react-native-shake
```

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

### List user feedback - curl example

Source: https://docs.shakebugs.com/docs/rest-api/modules/user-feedback

Example curl request to list user feedback. Requires an API key header and uses limit and offset query parameters.

```bash
curl -H "X-API-KEY: your_rest_api_key_here" \
  "https://dashboard-api.shakebugs.com/api/rest/issue_tracking/issues?limit=20&offset=0"
```

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

### integrate_shake_sdk

Source: https://docs.shakebugs.com/docs/mcp/tools-resources-prompts

Wires the Shake SDK into the repository you have open. Detects the platform from the project files, calls setup_shake_app to find or create the app, and installs the SDK with the key it returns.

```APIDOC
## Prompt: integrate_shake_sdk

### Description
Wires the Shake SDK into the repository you have open. Detects the platform from the project files rather than asking you, calls `setup_shake_app` to find or create the app, and installs the SDK with the key it returns.

### Inputs
- **workspace** (optional) - You are asked only if you have more than one workspace.
```

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

### Get Crash Event Details - curl Example

Source: https://docs.shakebugs.com/docs/rest-api/modules/crash-reporting

Example curl command to get crash event details. Requires an API key in the X-API-KEY header.

```bash
curl -H "X-API-KEY: your_rest_api_key_here" \
  https://dashboard-api.shakebugs.com/api/rest/crash_reporting/crash_events/660e8400-e29b-41d4-a716-446655440000
```

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

### Get user feedback details - curl example

Source: https://docs.shakebugs.com/docs/rest-api/modules/user-feedback

Example curl request to get details for a specific feedback item. Requires an API key header and the issue_id in the URL.

```bash
curl -H "X-API-KEY: your_rest_api_key_here" \
  https://dashboard-api.shakebugs.com/api/rest/issue_tracking/issues/550e8400-e29b-41d4-a716-446655440000
```

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

### Get Crash Group Details - Example Request

Source: https://docs.shakebugs.com/docs/rest-api/modules/crash-reporting

Example curl command to get details for a specific crash group using its UUID. Requires an API key in the X-API-KEY header.

```bash
curl -H "X-API-KEY: your_rest_api_key_here" \
  https://dashboard-api.shakebugs.com/api/rest/crash_reporting/crash_groups/550e8400-e29b-41d4-a716-446655440000
```

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

### setup_shake_app

Source: https://docs.shakebugs.com/docs/mcp/tools-resources-prompts

Finds or creates a Shake app in a workspace and returns its SDK key. This is the tool behind the integrate_shake_sdk prompt.

```APIDOC
## setup_shake_app

### Description
Finds or creates a Shake app in a workspace and returns its SDK key. The tool behind the `integrate_shake_sdk` prompt.

### Input
- `workspace` (string) - Required - The workspace in which to find or create the app.
- `platform` (string) - Required - The platform of the app. For mobile, use `Flutter` or `ReactNative`; for Web, use `Web`. If both iOS and Android exist, qualify the platform (e.g., `"Flutter (iOS)"`).
- `bundle_id` (string) - Required for mobile, ignored for Web - The bundle identifier of the app.
- `app_name` (string) - Optional - The name of the app.

### Output
- `sdk_key` (string) - The SDK key for the app. This is a credential and should be stored in environment variables or a secrets file, never in source control.

### Notes
- An app that already exists with the same platform and bundle id is returned as-is, never duplicated.
```

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

### Set up a custom theme with SHKTheme (Objective-C)

Source: https://docs.shakebugs.com/docs/ios/configuration-and-data/custom-branding

Creates and assigns a new SHKTheme instance to SHKShake.configuration.theme in AppDelegate.m. Use this to customize fonts, colors, border radius, and shadow for Shake screens.

```objectivec
SHKShake.configuration.theme = [[SHKTheme alloc] initWithFontFamilyMedium:@"Charter-Roman"
                  fontFamilyBold:@"Charter-Bold"
                  background:UIColor.grayColor
                  secondaryBackground:UIColor.lightGrayColor
                  textColor:UIColor.blackColor
                  secondaryTextColor:UIColor.blackColor
                  brandAccentColor:UIColor.orangeColor
                  brandTextColor:UIColor.whiteColor
                  borderRadius:39
                  outlineColor:UIColor.blackColor
                  shadowInfo:[[SHKShadowInfo alloc]initWithOffset:CGSizeMake(4, 2)
                  opacity:1
                  radius:2
                  color:UIColor.blackColor]];
```

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

### Forward Firebase token to Shake with Shake.setPushNotificationsToken

Source: https://docs.shakebugs.com/docs/flutter/users/chat

Call Shake.setPushNotificationsToken on app start to forward the Firebase device token to Shake, enabling targeted push notifications for Android. Requires Firebase and Firebase Messaging setup. The example shows the method call within the app's main function.

```dart
import 'package:firebase_core/firebase_core.dart';
import 'package:firebase_messaging/firebase_messaging.dart';
import 'package:shake_flutter/shake_flutter.dart';

void setShakePushNotificationsToken() async {
    String? fcmToken = await FirebaseMessaging.instance.getToken();
    Shake.setPushNotificationsToken(fcmToken);
};

void main() async {
    WidgetsFlutterBinding.ensureInitialized();

    await Shake.start('app-api-key');
    await Firebase.initializeApp();
    
    setShakePushNotificationsToken();
    
    runApp(Home());
}
```

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

### Initialize Shake with API key in index.js

Source: https://docs.shakebugs.com/docs/web/install/cdn

Call Shake.start() in your main file, replacing 'app-api-key' with your actual key from app settings.

```js
window.Shake.start('app-api-key');
```

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

### Initialize Shake in index.js (JavaScript)

Source: https://docs.shakebugs.com/docs/react/installation

Call Shake.start() in the entry file. Replace 'ios-app-api-key' and 'android-app-api-key' with actual values from app settings. The API key is chosen based on the platform.

```javascript
import { Platform } from 'react-native';
import Shake from '@shakebugs/react-native-shake';

AppRegistry.registerComponent(appName, () => App);

const apiKey = Platform.OS === 'ios' ? 'ios-app-api-key' : 'android-app-api-key';
Shake.start(apiKey);
```

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

### Set up a custom theme with SHKTheme (Swift)

Source: https://docs.shakebugs.com/docs/ios/configuration-and-data/custom-branding

Creates and assigns a new SHKTheme instance to Shake.configuration.theme in AppDelegate.swift. Use this to customize fonts, colors, border radius, and shadow for Shake screens.

```swift
Shake.configuration.theme = SHKTheme(fontFamilyMedium: "Charter-Roman",
               fontFamilyBold: "Charter-Bold",
               background: .gray,
               secondaryBackground: .lightGray,
               textColor: .black,
               secondaryTextColor: .black,
               brandAccentColor: .orange,
               brandTextColor: .white,
               borderRadius: 39,
               outlineColor: .black,
               shadowInfo: .init(offset: .init(width: 4, height: 2), opacity: 1, radius: 2, color: .black))
```

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

### Response for Get Chat Messages

Source: https://docs.shakebugs.com/docs/rest-api/modules/crash-reporting

Example JSON response for the GET chat messages endpoint. Contains a chat array with message objects and an activity array with activity objects.

```json
{
  "chat": [
    {
      "id": "uuid",
      "message": "Looking into this crash",
      "is_note": false,
      "is_read": true,
      "created": "2024-01-01T12:00:00Z",
      "updated": "2024-01-01T12:00:00Z"
    }
  ],
  "activity": [
    {
      "id": "uuid",
      "activity_type": "status_change",
      "activity_description": "Status changed to In Progress",
      "created": "2024-01-01T12:00:00Z"
    }
  ]
}
```

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

### Try It Out

Source: https://docs.shakebugs.com/docs/rest-api/overview

Provides the URL to the interactive API documentation where users can test endpoints.

```APIDOC
## Try It Out

You can test API endpoints and explore the interactive documentation at:

```text
https://dashboard-api.shakebugs.com/api/rest/
```

Feel free to experiment there!
```

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

### Get Chat Messages - curl Example

Source: https://docs.shakebugs.com/docs/rest-api/modules/user-feedback

Example curl command to retrieve chat messages. Requires an API key in the X-API-KEY header and uses the dashboard API base URL.

```bash
curl -H "X-API-KEY: your_rest_api_key_here" \
  https://dashboard-api.shakebugs.com/api/rest/issue_tracking/issues/550e8400-e29b-41d4-a716-446655440000/chat
```

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

### Get Activity Logs curl Example

Source: https://docs.shakebugs.com/docs/rest-api/modules/crash-reporting

Example curl command to fetch activity logs for a crash event. Requires a valid REST API key in the 'X-API-KEY' header and a valid crash event UUID in the URL.

```bash
curl -H "X-API-KEY: your_rest_api_key_here" \
  https://dashboard-api.shakebugs.com/api/rest/crash_reporting/crash_events/660e8400-e29b-41d4-a716-446655440000/logs
```

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

### Initialize Shake with API key

Source: https://docs.shakebugs.com/docs/web/install/npm

Call Shake.start() in your main file (e.g., index.js) with your actual app API key. Requires ES6 imports and a CSS loader if using npm.

```js
import Shake from '@shakebugs/browser';

Shake.start('app-api-key');
```

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

### Conditional initialization in index.ts (TypeScript)

Source: https://docs.shakebugs.com/docs/react/installation

TypeScript version of conditional initialization. The apiKey is typed as string. The example shows starting Shake only when User.isTester is true.

```typescript
import { Platform } from 'react-native';
import Shake from '@shakebugs/react-native-shake';

const MainScreen = () => {
    useEffect(() => {
        if (User.isTester) {
            const apiKey: string = Platform.OS === 'ios' ? 'ios-app-api-key' : 'android-app-api-key';
            Shake.start(apiKey);
        }
    }, []);
};
```

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

### Conditional initialization in index.js (JavaScript)

Source: https://docs.shakebugs.com/docs/react/installation

Initialize Shake only when a condition is met (e.g., User.isTester). The example uses useEffect to start Shake after the component mounts.

```javascript
import { Platform } from 'react-native';
import Shake from '@shakebugs/react-native-shake';

const MainScreen = () => {
    useEffect(() => {
        if (User.isTester) {
            const apiKey = Platform.OS === 'ios' ? 'ios-app-api-key' : 'android-app-api-key';
            Shake.start(apiKey);
        }
    }, []);
};
```

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

### Use ShakePrivateView in MainActivity.kt

Source: https://docs.shakebugs.com/docs/android/configuration-and-data/manage-sensitive-data

Shows how to wrap a composable (e.g., Greeting) with ShakePrivateView so that it is removed from screenshots. The example is inside a typical Compose activity setup.

```kotlin
class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContent {
            ComposeTestTheme {
                Surface(color = MaterialTheme.colors.background) {
                    ShakePrivateView {
                        Greeting("Android")
                    }
                }
            }
        }
    }
}
```

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

### ShakeFile initWithName:andFileURL:

Source: https://docs.shakebugs.com/docs/ios/configuration-and-data/auto-attach-files

Initializes a ShakeFile with a custom filename and a local file URL. Use this to attach a file from a local path with a specified name.

```APIDOC
## ShakeFile initWithName:andFileURL:

### Description
Initializes a ShakeFile with a custom filename and a local file URL. Use this to attach a file from a local path with a specified name.

### Method
Initializer

### Parameters
- **name** (String) - Required - The custom filename for the attached file.
- **fileURL** (NSURL / URL) - Required - The local URL to the file.

### Usage Example (Objective-C)
```objectivec
NSString *fileName = ...
NSURL *fileUrl = ...

SHKShake.onPrepareReportData = ^NSArray<SHKShakeFile *> * _Nonnull {
    NSMutableArray <SHKShakeFile *> *attachedFiles = NSMutableArray.new;
    SHKShakeFile *attachedFile = [[SHKShakeFile alloc] initWithName:fileName andFileURL:fileUrl];
    [attachedFiles addObject:attachedFile];
    return attachedFiles;
};
```

### Usage Example (Swift)
```swift
let fileName: String = ...
let fileUrl: URL = ...

Shake.onPrepareReportData = {
    var attachedFiles = [ShakeFile]()
    if let attachedFile = ShakeFile(name: fileName, fileUrl: fileUrl) {
        attachedFiles.append(attachedFile)
    }
    return attachedFiles
}
```
```

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

### Forward Firebase token to Shake (TypeScript)

Source: https://docs.shakebugs.com/docs/react/users/chat

Call Shake.setPushNotificationsToken on app start to forward the Firebase token for Android. Requires Firebase and FCM setup. This is the TypeScript version.

```typescript
import { AppRegistry, Platform } from 'react-native';

import Shake from '@shakebugs/react-native-shake';
import messaging from '@react-native-firebase/messaging';

const setShakePushNotificationsToken = async (): Promise<void> => {
    if (Platform.OS === 'android') {
        const fcmToken: string = await messaging().getToken();
        Shake.setPushNotificationsToken(fcmToken);
    }
};

setShakePushNotificationsToken();

Shake.start('app-api-key');

AppRegistry.registerComponent(appName, () => App);
```

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

### Forward Firebase token to Shake (JavaScript)

Source: https://docs.shakebugs.com/docs/react/users/chat

Call Shake.setPushNotificationsToken on app start to forward the Firebase token for Android. Requires Firebase and FCM setup. This is the JavaScript version.

```javascript
import { AppRegistry, Platform } from 'react-native';

import Shake from '@shakebugs/react-native-shake';
import messaging from '@react-native-firebase/messaging';

const setShakePushNotificationsToken = async () => {
    if (Platform.OS === 'android') {
        const fcmToken = await messaging().getToken();
        Shake.setPushNotificationsToken(fcmToken);
    }
};

setShakePushNotificationsToken();

Shake.start('app-api-key');

AppRegistry.registerComponent(appName, () => App);
```

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

### shake_whoami

Source: https://docs.shakebugs.com/docs/mcp/tools-resources-prompts

Lists your workspaces and apps. Call this first to get workspace slugs, names, roles, and app details including app_key, platform, bundle id, and approval state.

```APIDOC
## shake_whoami

### Description
Lists your workspaces and apps. Call this first. Returns each workspace's slug, name and your role in it, plus every app you can access with its `app_key`, platform, bundle id and approval state.

### Input Parameters
- `include_search_fields` (optional) - Also returns the metadata keys each app records, for filtering in `search_tickets`. Off by default, because collecting them samples up to 500 tickets per app.

### Access
Read-only
```

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

### Get Activity Logs Response JSON

Source: https://docs.shakebugs.com/docs/rest-api/modules/crash-reporting

Example JSON response containing activity logs for a crash event, including user actions, network requests, system events, and timestamps.

```json
{
  "id": "uuid",
  "user_actions": [...],
  "network_requests": [...],
  "system_events": [...],
  "view_controller_history": [...],
  "notification_events": [...],
  "custom_log_events": [...],
  "console_log_events": [...],
  "created": "2024-01-01T12:00:00Z",
  "updated": "2024-01-01T12:00:00Z"
}
```

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

### Set a custom filename and then attach a file (Objective-C)

Source: https://docs.shakebugs.com/docs/ios/configuration-and-data/auto-attach-files

Initializes SHKShakeFile with a filename and a local file URL, then returns it in the onPrepareReportData block. The variables fileName and fileUrl are placeholders to be replaced with actual values.

```objectivec
NSString *fileName = ...
NSURL *fileUrl = ...

CopySHKShake.onPrepareReportData = ^NSArray<SHKShakeFile *> * _Nonnull {
    NSMutableArray <SHKShakeFile *> *attachedFiles = NSMutableArray.new;
    SHKShakeFile *attachedFile = [[SHKShakeFile alloc] initWithName:fileName andFileURL:fileUrl];
    [attachedFiles addObject:attachedFile];
    return attachedFiles;
};
```

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

### Filter out specific network requests by URL (JavaScript)

Source: https://docs.shakebugs.com/docs/react/configuration-and-data/manage-sensitive-data

Return null from the NetworkRequestsFilter to prevent logging requests whose URL starts with 'https://api.myapp.com/cards'. This example shows the JavaScript implementation.

```javascript
import Shake from '@shakebugs/react-native-shake';

const setupNetworkFilter = () => {
    Shake.setNetworkRequestsFilter((networkRequest) => {
        if (networkRequest.getUrl().startsWith('https://api.myapp.com/cards')) {
            return null;
        }
        return networkRequest;
    });
}
```

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

### ShakeFile initWithFileURL:

Source: https://docs.shakebugs.com/docs/ios/configuration-and-data/auto-attach-files

Initializes a ShakeFile with only a local file URL. The filename is automatically determined from the file's name.

```APIDOC
## ShakeFile initWithFileURL:

### Description
Initializes a ShakeFile with only a local file URL. The filename is automatically determined from the file's name.

### Method
Initializer

### Parameters
- **fileURL** (NSURL / URL) - Required - The local URL to the file.

### Usage Example (Objective-C)
```objectivec
NSURL *fileUrl = ...

SHKShake.onPrepareReportData = ^NSArray<SHKShakeFile *> * _Nonnull {
    NSMutableArray <SHKShakeFile *> *attachedFiles = NSMutableArray.new;
    SHKShakeFile *attachedFile = [[SHKShakeFile alloc] initWithFileURL:fileUrl];
    [attachedFiles addObject:attachedFile];
    return attachedFiles;
};
```

### Usage Example (Swift)
```swift
let fileUrl: URL = ...

Shake.onPrepareReportData = {
    var attachedFiles = [ShakeFile]()
    if let attachedFile = ShakeFile(fileUrl: fileUrl) {
        attachedFiles.append(attachedFile)
    }
    return attachedFiles
}
```
```

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

### Get Crash Event Details - Response JSON

Source: https://docs.shakebugs.com/docs/rest-api/modules/crash-reporting

Example JSON response for the crash event details endpoint. Includes device info, stack trace, custom fields, and associated files.

```json
{
  "id": "uuid",
  "title": "NullPointerException in MainActivity",
  "app_version": "1.2.3",
  "build_version": "123",
  "device": "Samsung Galaxy S21",
  "os_name": "Android",
  "os_version": "12",
  "issue_reported_time": "2024-01-01T12:00:00Z",
  "screenshot_url": "https://...",
  "video_url": "https://...",
  "files": [
    {
      "id": "uuid",
      "url": "https://...",
      "filename": "crash_log.txt"
    }
  ],
  "custom_fields": [
    {
      "type": "string",
      "label": "User ID",
      "value": "12345"
    }
  ],
  "app_user": {
    "id": "uuid",
    "end_user_id": "user@example.com"
  }
}
```

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

### Set app version in Shake.start()

Source: https://docs.shakebugs.com/docs/web/install/cdn

Pass the app version as the optional second argument to Shake.start(). If not passed, it defaults to "1.0.0".

```js
window.Shake.start('app-api-key', '1.0.0');
```

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

### Get Activity Logs - JSON Response

Source: https://docs.shakebugs.com/docs/rest-api/modules/user-feedback

Example JSON response containing activity logs with user actions, network requests, system events, view controller history, notification events, custom log events, and console log events.

```json
{
  "id": "uuid",
  "user_actions": [
    {
      "timestamp": "2024-01-01T10:29:45Z",
      "action": "button_tap",
      "element": "login_button"
    }
  ],
  "network_requests": [
    {
      "timestamp": "2024-01-01T10:29:50Z",
      "method": "POST",
      "url": "https://api.example.com/login",
      "status_code": 500,
      "response_time": 1234
    }
  ],
  "system_events": [
    {
      "timestamp": "2024-01-01T10:29:55Z",
      "event": "memory_warning",
      "details": "Low memory warning received"
    }
  ],
  "view_controller_history": [
    {
      "timestamp": "2024-01-01T10:29:00Z",
      "view": "LoginViewController"
    }
  ],
  "notification_events": [
    {
      "timestamp": "2024-01-01T10:28:00Z",
      "notification": "push_notification_received",
      "title": "New message"
    }
  ],
  "custom_log_events": [
    {
      "timestamp": "2024-01-01T10:29:30Z",
      "level": "error",
      "message": "Failed to authenticate user"
    }
  ],
  "console_log_events": [
    {
      "timestamp": "2024-01-01T10:29:35Z",
      "level": "error",
      "message": "Network request failed: timeout"
    }
  ],
  "created": "2024-01-01T10:30:00Z",
  "updated": "2024-01-01T10:30:00Z"
}
```

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

### Create and set a custom ShakeTheme (Java)

Source: https://docs.shakebugs.com/docs/android/configuration-and-data/custom-branding

Creates a ShakeTheme with custom font, color, and dimension resources, then sets it on the report configuration. Use this to apply a fully custom theme to Shake screens.

```java
ShakeTheme shakeTheme = new ShakeTheme(
    R.font.font_medium,
    R.font.font_bold,
    R.color.background_color,
    R.color.secondary_background_color,
    R.color.text_color,
    R.color.secondary_text_color,
    R.color.accent_color,
    R.color.accent_text_color,
    R.color.outline_color,
    R.dimen.border_radius,
    R.dimen.card_elevation
);

Shake.getReportConfiguration().setTheme(shakeTheme);
```

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

### Get Chat Messages - JSON Response

Source: https://docs.shakebugs.com/docs/rest-api/modules/user-feedback

Example response containing a chat array with message objects and an activity array with activity objects. Shows fields like id, message, is_note, is_read, created, updated, edited_at, and activity details.

```json
{
  "chat": [
    {
      "id": "uuid",
      "message": "Thanks for reporting this! We're looking into it.",
      "is_note": false,
      "is_read": true,
      "created": "2024-01-01T12:00:00Z",
      "updated": "2024-01-01T12:00:00Z",
      "edited_at": null
    },
    {
      "id": "uuid",
      "message": "Internal note: This is a known issue in v2.1.0",
      "is_note": true,
      "is_read": true,
      "created": "2024-01-01T12:05:00Z",
      "updated": "2024-01-01T12:05:00Z",
      "edited_at": null
    }
  ],
  "activity": [
    {
      "id": "uuid",
      "activity_type": "status_change",
      "activity_description": "Status changed from New to In Progress",
      "activity_url": null,
      "created": "2024-01-01T12:10:00Z",
      "updated": "2024-01-01T12:10:00Z"
    }
  ]
}
```

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

### GET /crash_reporting/crash_groups

Source: https://docs.shakebugs.com/docs/rest-api/modules/crash-reporting

Get a paginated list of crash groups for your application.

```APIDOC
## GET /crash_reporting/crash_groups

### Description
Get a paginated list of crash groups for your application.

### Method
GET

### Endpoint
/crash_reporting/crash_groups

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of items to return. Default: 20. Range: 1-100.
- **offset** (integer) - Optional - Number of items to skip. Default: 0. Range: 0+.

### Request Example
```bash
curl -H "X-API-KEY: your_rest_api_key_here" \
  "https://dashboard-api.shakebugs.com/api/rest/crash_reporting/crash_groups?limit=20&offset=0"
```

### Response
#### Success Response (200)
- **total** (integer) - Total number of crash groups.
- **items** (array) - List of crash groups.
  - **id** (string) - Unique identifier of the crash group.
  - **key** (integer) - Key of the crash group.
  - **app_id** (string) - Unique identifier of the application.
  - **created** (string) - Creation timestamp.
  - **updated** (string) - Last update timestamp.
  - **active** (boolean) - Whether the crash group is active.
  - **report_type** (string) - Type of report (e.g., "crash").
  - **exception_type** (string) - Type of exception (e.g., "NullPointerException").
  - **title** (string) - Title of the crash group.
  - **subtitle** (string) - Subtitle of the crash group.
  - **status** (object) - Status of the crash group.
    - **status** (string) - Status value (e.g., "New").
  - **priority** (object) - Priority of the crash group.
    - **priority** (string) - Priority value (e.g., "High").
  - **assignee** (object) - Assignee of the crash group.
    - **assignee_id** (string) - Unique identifier of the assignee.
  - **tags** (array) - List of tags.
  - **crash_events_count** (integer) - Number of crash events.
  - **last_event** (string) - Unique identifier of the last event.

#### Response Example
```json
{
  "total": 150,
  "items": [
    {
      "id": "uuid",
      "key": 1,
      "app_id": "uuid",
      "created": "2024-01-01T00:00:00Z",
      "updated": "2024-01-01T00:00:00Z",
      "active": true,
      "report_type": "crash",
      "exception_type": "NullPointerException",
      "title": "Crash in MainActivity",
      "subtitle": "at com.example.MainActivity.onCreate",
      "status": {
        "status": "New"
      },
      "priority": {
        "priority": "High"
      },
      "assignee": {
        "assignee_id": "uuid"
      },
      "tags": ["android"],
      "crash_events_count": 42,
      "last_event": "uuid"
    }
  ]
}
```
```

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

### ShakeFile initWithName:andData:

Source: https://docs.shakebugs.com/docs/ios/configuration-and-data/auto-attach-files

Initializes a ShakeFile with a custom filename and data. Use this to attach a file with a specified name and data content.

```APIDOC
## ShakeFile initWithName:andData:

### Description
Initializes a ShakeFile with a custom filename and data. Use this to attach a file with a specified name and data content.

### Method
Initializer

### Parameters
- **name** (String) - Required - The custom filename for the attached file.
- **data** (NSData / Data) - Required - The data content of the file.

### Usage Example (Objective-C)
```objectivec
NSString *fileName = ...
NSData *fileData = ...

SHKShake.onPrepareReportData = ^NSArray<SHKShakeFile *> * _Nonnull {
    NSMutableArray <SHKShakeFile *> *attachedFiles = NSMutableArray.new;
    SHKShakeFile *attachedFile = [[SHKShakeFile alloc] initWithName:fileName andData:fileData];
    [attachedFiles addObject:attachedFile];
    return attachedFiles;
};
```

### Usage Example (Swift)
```swift
let fileName: String = ...
let logData: Data = ...

Shake.onPrepareReportData = {
    var attachedFiles = [ShakeFile]()
    let attachedFile = ShakeFile(name: fileName, data: fileData)
    attachedFiles.append(attachedFile)

    return attachedFiles
}
```
```

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

### Pagination Example: Fetch crash groups with curl

Source: https://docs.shakebugs.com/docs/rest-api/overview

Shows how to use the limit and offset query parameters to paginate through crash groups. The first command fetches the first 50 crash groups, the second fetches the next 50. Requires a REST API key.

```bash
# Get the first 50 crash groups
curl -H "X-API-KEY: your_rest_api_key_here" \
  "https://dashboard-api.shakebugs.com/api/rest/crash_reporting/crash_groups?limit=50&offset=0"

# Get the next 50 crash groups
curl -H "X-API-KEY: your_rest_api_key_here" \
  "https://dashboard-api.shakebugs.com/api/rest/crash_reporting/crash_groups?limit=50&offset=50"
```

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

### GET /crash_reporting/crash_groups/{crash_group_id}

Source: https://docs.shakebugs.com/docs/rest-api/modules/crash-reporting

Get detailed information about a specific crash group.

```APIDOC
## GET /crash_reporting/crash_groups/{crash_group_id}

### Description
Get detailed information about a specific crash group.

### Method
GET

### Endpoint
/crash_reporting/crash_groups/{crash_group_id}

### Parameters
#### Path Parameters
- **crash_group_id** (string) - Required - Unique identifier of the crash group.

### Request Example
```bash
curl -H "X-API-KEY: your_rest_api_key_here" \
  https://dashboard-api.shakebugs.com/api/rest/crash_reporting/crash_groups/550e8400-e29b-41d4-a716-446655440000
```

### Response
#### Success Response (200)
No response schema provided in the source.

#### Response Example
No response example provided in the source.
```

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

### Swift AppDelegate.h not needed

Source: https://docs.shakebugs.com/docs/react/users/chat

Indicates that no header file is needed for Swift projects.

```text
Not needed for Swift
```

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

### Set custom home actions in JavaScript (index.js)

Source: https://docs.shakebugs.com/docs/react/configuration-and-data/home-screen

Example of setting custom home actions in JavaScript. Imports Shake and action classes, creates an array of actions (custom, submit, chat), and passes them to Shake.setHomeActions. The custom action icon must be in base64 format without the data:image/png;base64 prefix.

```javascript
import Shake, {ShakeChatAction, ShakeHomeAction, ShakeSubmitAction} from '@shakebugs/react-native-shake';

const setShakeHomeActions = () => {
    const actions = [
        new ShakeHomeAction(
            'Visit our roadmap',
            'Check what features are next',
            roadmapImage,
            () => {
                // Open URL
            },
        ),
        new ShakeSubmitAction(
            'Submit a new ticket',
            'Let us know your problem',
            submitImage,
        ),
        new ShakeChatAction(
            'Start a chat',
            'We are here to answer you questions',
            chatImage,
        ),
    ];

    Shake.setHomeActions(actions);
};
```

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

### List Crash Events for a Group - curl Example

Source: https://docs.shakebugs.com/docs/rest-api/modules/crash-reporting

Example curl command to list crash events for a crash group. Requires an API key in the X-API-KEY header. The example uses limit=20 and a sample crash group ID.

```bash
curl -H "X-API-KEY: your_rest_api_key_here" \
  "https://dashboard-api.shakebugs.com/api/rest/crash_reporting/crash_groups/550e8400-e29b-41d4-a716-446655440000/crash_events?limit=20"
```

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

### GET /issue_tracking/issues

Source: https://docs.shakebugs.com/docs/rest-api/modules/user-feedback

Get a paginated list of user feedback for your application. Supports limit and offset query parameters for pagination.

```APIDOC
## GET /issue_tracking/issues

### Description
Get a paginated list of user feedback for your application.

### Method
GET

### Endpoint
/issue_tracking/issues

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of items to return. Default: 20. Range: 1-100.
- **offset** (integer) - Optional - Number of items to skip. Default: 0. Range: 0+.

### Response
#### Success Response (200)
- **total** (integer) - Total number of feedback items.
- **current_month_issues** (integer) - Number of issues reported in the current month.
- **items** (array) - List of feedback items. Each item contains:
  - **id** (string) - Unique identifier of the feedback.
  - **key** (integer) - Numeric key of the feedback.
  - **app_id** (string) - Identifier of the application.
  - **title** (string) - Title of the feedback.
  - **app_version** (string) - Version of the app.
  - **issue_reported_time** (string) - Timestamp when the issue was reported.
  - **created** (string) - Creation timestamp.
  - **updated** (string) - Last update timestamp.
  - **status** (object) - Status information with fields: status (string), updated (string).
  - **priority** (object) - Priority information with fields: priority (string), updated (string).
  - **assignee** (object) - Assignee information with fields: assignee_id (string), name (string), email (string), updated (string).
  - **tags** (array) - List of tags.
  - **screenshot_url** (string) - URL of screenshot.
  - **video_url** (string) - URL of video.
  - **app_user** (object) - App user information with fields: id (string), end_user_id (string).
  - **custom_fields** (array) - List of custom fields, each with type (string), label (string), value (string).
  - **files** (array) - List of files, each with id (string), url (string), filename (string).

#### Response Example
```json
{
  "total": 245,
  "current_month_issues": 18,
  "items": [
    {
      "id": "uuid",
      "key": 1,
      "app_id": "uuid",
      "title": "Login button not working",
      "app_version": "2.1.0",
      "issue_reported_time": "2024-01-01T10:30:00Z",
      "created": "2024-01-01T10:30:00Z",
      "updated": "2024-01-02T14:20:00Z",
      "status": {
        "status": "New",
        "updated": "2024-01-01T10:30:00Z"
      },
      "priority": {
        "priority": "High",
        "updated": "2024-01-01T10:30:00Z"
      },
      "assignee": {
        "assignee_id": "uuid",
        "name": "John Doe",
        "email": "john@example.com",
        "updated": "2024-01-01T11:00:00Z"
      },
      "tags": ["bug", "ui"],
      "screenshot_url": "https://...",
      "video_url": "https://...",
      "app_user": {
        "id": "uuid",
        "end_user_id": "user@example.com"
      },
      "custom_fields": [
        {
          "type": "string",
          "label": "Device Type",
          "value": "Mobile"
        }
      ],
      "files": [
        {
          "id": "uuid",
          "url": "https://...",
          "filename": "screenshot.png"
        }
      ]
    }
  ]
}
```

### Example Request
```bash
curl -H "X-API-KEY: your_rest_api_key_here" \
  "https://dashboard-api.shakebugs.com/api/rest/issue_tracking/issues?limit=20&offset=0"
```
```

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

### Create SHKPicker in Objective-C

Source: https://docs.shakebugs.com/docs/ios/configuration-and-data/custom-forms

Initializes a picker with key, label, and items array. Use in AppDelegate.m.

```objectivec
SHKPicker *picker = [[SHKPicker alloc] initWithKey:@"console_picker label:@"Choose your console" items:@[pickerItem]];
```

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

### curl example for deleting user feedback

Source: https://docs.shakebugs.com/docs/rest-api/modules/user-feedback

Example curl command to delete user feedback using the DELETE method.

```bash
curl -X DELETE \
  -H "X-API-KEY: your_rest_api_key_here" \
  https://dashboard-api.shakebugs.com/api/rest/issue_tracking/issues/550e8400-e29b-41d4-a716-446655440000
```

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

### Initialize Shake in main.dart

Source: https://docs.shakebugs.com/docs/flutter/installation

Call Shake.start() in your main.dart file. Replace ios-app-api-key and android-app-api-key with your actual API keys from the Shake Dashboard. The example uses Platform.isIOS to select the appropriate key.

```dart
import 'dart:io';
import 'package:flutter/material.dart';
import 'package:shake_flutter/shake_flutter.dart';

void main() {
    WidgetsFlutterBinding.ensureInitialized();

    String apiKey = Platform.isIOS ? 'ios-app-api-key' : 'android-app-api-key';
    Shake.start(apiKey);

    runApp(Home());
}
```
Tokens:
Raw