Welcome to Instabug's Documentation!
Here you'll find a comprehensive technical guide
to help you start working with the Instabug SDK efficiently.

Get Started

Setting Custom Data

Discussed here is how to set user attributes and tags, as well as log user events, and their relevant APIs.

User Attributes

You can assign custom attributes to your users and they will show up on your Instabug dashboard with each report. These attributes can later be used to filter reports in your dashboard.

This is where additional user attributes appear in your bug reports.

To add a new user attribute, use the following method.

Instabug.setUserAttribute("True", withKey: "Logged in")
Instabug.setUserAttribute("False", withKey: "Completed IAP")
[Instabug setUserAttribute:@"True" withKey:@"Logged in"];
[Instabug setUserAttribute:@"18" withKey:@"Age"];

You can also retrieve or remove the current value of a certain user attribute.

let loggedIn = Instabug.userAttribute(forKey: "Logged in")
Instabug.removeUserAttribute(forKey: "Logged in")
NSString *loggedIn = [Instabug userAttributeForKey:@"Logged in"];
[Instabug removeUserAttributeForKey:@"Logged in"];

Or retrieve all user attributes.

let allUserAttributes = Instabug.userAttributes()
NSDictionary *allUserAttributes = [Instabug userAttributes];

User Events

You can log custom user events throughout your application. Custom events are automatically included with each report.

Instabug.logUserEvent(withName: "Skipped Walkthrough")
[Instabug logUserEventWithName:@"Skipped Walkthrough"];


You can add custom tags to your bug and crash reports. These tags can later be used to filter reports or set custom rules from your dashboard.

This is where tags appear in your bug reports.

The example below demonstrates how to add tags to a report.

Instabug.appendTags(["Design", "Flow"])
[Instabug appendTags:@[@"Design", @"Flow"]];


Adding tags before sending reports

Sometimes it's useful to be able to add a tag to a bug report before it's been sent. In these cases, the perfect solution would be use the event handlers of the bug reporting class. You can find more details here.

You can also get all the currently set tags as follows.

let tags = Instabug.getTags()
NSString *tags = [Instabug getTags];

Last, you can reset all the tags.

[Instabug resetTags];

Managing Tags

If you'd like to remove a particular tag from your dashboard to prevent it from appearing again when entering a new tag manually, you can do so by navigating to the tags page under the settings options and remove the tag. You can also edit and rename the tag.

Updated 6 months ago

What's Next

You now have more information than ever about each bug and crash report, so we suggest you read up more on bug reporting. Also, did you know that you can use custom user attributes and events to target surveys?

Bug Reporting
Crash Reporting
Targeting Surveys

Setting Custom Data

Discussed here is how to set user attributes and tags, as well as log user events, and their relevant APIs.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.