App keys are one of the best mechanisms for providing top-level separation of data. Best practices dictate one app key for each app, device platform, and environment. Creating separate app keys enables you to easily uncover insights between platforms, send more customized messaging campaigns by platform, and separate test data from production. Use cross-app analytics to compare data across multiple app keys.
|Name||For an app with both iOS and Android versions, create each new app key with the following names.
|Platform||Select the appropriate device platform.|
|Category||Select the appropriate category for your app. The Usage report will provide data to benchmark your app’s performance against your chosen category.|
|Select icon (Optional)||Upload your app’s icon to display in the app selector drop-down.|
|Time Zone||Choose the timezone in which all app data will be reported. Best practice is to choose the timezone of your company headquarters or UTC. Choose wisely as this should never be changed. All messaging campaigns will be sent in the time zone you set for the app, unless delivered in the user’s timezone is selected.|
|Customer Value||Select the appropriate value you are tracking in LTV reporting. Choose Tracked as Money if you are tracking monetary values related to revenue or purchases. Choose Raw Value if value maps to some other in-app metric, like “movies watched” or “ads viewed.”|
|Custom Dimension Labels||Custom Dimensions are assigned a numeric value during the app tagging process. Apply a label here to describe and display Custom Dimensions in the Dashboard. Here’s an example: CUSTOM_DIMENSION_0: Subscriber type.|
|Channels (for Android)||Starting with Android Oreo (v8.0) you're required to specify a channel (shown as a category on the end user's device) for all push messages sent. Your developers will need to specify channel information within your app. Make sure this information is kept up to date in Localytics.
If a push message is rendered by the device without a channel, it will never be shown to the end user. To avoid this, Localytics will create a default channel for push messages if none are specified or exist on the device. This default channel will assume default specifications—like importance, name (shown as the channel ID), sound, and vibration setting—and will be uneditable within the Localytics dashboard. For more information on how you can create channels, please refer to the official Android documentation.
Select the wheel in the top bar of each app key to manage your app keys or to add push messaging certificates. Follow the instructions to add your iOS Push Certificate and/or your Google Cloud Messaging API key to enable push messaging. Prevent push errors by correctly match development and production certificates with the Push Mode drop-down.
Rapid Push Verification
Localytics’ Rapid Push Verification helps you confirm that you have properly configured your app to receive Localytics push notifications and detects any issues with your integration, providing guidance on how you can fix the problem. In the Settings page in the Localytics Dashboard, scroll down until you find the app you want to test and click on the blue button that says, “Test Push Integration” and follow the instructions listed on the page. For more step-by-step instructions to successfully test or troubleshoot your push integration, view the video below. For more on how Rapid Push Verification works and its capabilities, you can also read this blog post.
Invite new users and manage user permissions on the Users tab. When adding a new user, set the user's default permission type and role. After a new users is added, an invite email is sent to the user for confirmation. Permissions are scoped at the app and organization levels. Org-level permissions apply to all apps included in your Localytics account. App-level permissions are more granular and pertain only to an individual app within Localytics.
Org-level permissions are the most broad and apply to all apps included in the Localytics account. Three levels of permissions exist: Admin, Creator, and Member. As you can see in the table below, the Admin has access to all actions available within the Localytics dashboard. The Admin is able to manage all users: add users, remove users, and manage their permissions. The Creator is unable to manage other users, yet still has permission to perform task-oriented actions: create apps, modify app permissions, share custom dashboards, as well as bulk upload Profiles. A Member serves as a read-only role, lacking the ability to perform any of the actions listed below within their instance of Localytics.
|Manage default permissions||✓|
|Create new apps||✓||✓|
|View app permissions||✓||✓|
|Modify app permissions||✓||✓|
|Share custom dashboard||✓||✓||✓|
|Profile Bulk Upload||✓||✓|
|View Localytics API Key||✓||✓|
App-level permissions control a user’s access to information within a particular app. There exists the roles of Owner, Marketer, Viewer, and No Access. Seen in the table below, the Owner is able to perform all actions within the given app. They can create and manage various campaigns, create and manage audiences, create and save reports, as well as manage their tagged Events. The Marketer persona becomes a bit more limited as they are unable to create and save reports, create and manage Audiences, and manage Events. However, they still have the ability to create and manage various campaigns (Marketing and Attribution). The next persona, Viewer, serves a similar role to the “Member” at the org-level. This set of permissions grants read-only access; the individual may only see components of the dashboard as they are unable to create, edit, or manage any aspect of Localytics.
No Access represents an individual who has no access to a specific app. For example, They have no apparent need to access a specific app (i.e. if an Android developer should not have access to the iOS version of an app).
|View app data||✓||✓||✓|
|Create or edit Attribution campaigns||✓||✓|
|Create/edit Marketing campaigns||✓||✓|
|Profile Bulk Upload||✓||✓|
|Modify app settings||✓|
To change permissions, navigate to the Permissions tab. As an organization Administrator, you can change permissions by app, user, or permission type. To modify user-level permissions, select your user in the By User menu. Then, modify the permissions as needed for each app. To modify app-level permissions, select the app in the By App menu. A list of people in your organization appears. Modify the permission level for any individual. If you want to modify the permissions for several users at the same permission level, you can filter by permission level using the By Permission menu after you've chosen an app or user.
To make sure your users are setup for success using Localytics, having the correct permissions in place sets appropriate guardrails to avoid accidental/unnecessary changes that could cause adverse effects on your engagement strategy or administrative settings. Setting proper permissions also removes a number of possible roadblocks a dashboard user may encounter while looking to complete an objective. To make sure your permissions are configured correctly, keep in mind the following recommendations:
- Define org-level permission prior to app-level. Org-level permissions are a more all-encompassing set of permissions that will have downstream impact when setting more granular app-level permissions.
- Grant app-level permission only to users who have direct involvement with a given app. Avoid the confusion of navigating to the wrong app (or build of an app) by eliminating the possibility altogether! If anything, grant Viewer access so no physical changes can be made by indirect stakeholders.
To ensure that your instance of Localytics remains healthy, an individual from each functional group currently using Localytics should serve as an Admin/Owner while subordinates have lower-level permissions. For example, this helps with a number of use cases:
- An individual is looking to send out a messaging campaign, but the Owner wants to be sure that they are unable to target outside of the the Audiences already defined. By giving that user Marketer level permissions, this guardrail is in place.
- Similar to the above scenario, an individual who is heavier on the analytics portion of Localytics may deal more with User Insights reports (Segments, Funnels, etc.). To make sure these analysts are looking at the most critical reports, the Owner is able to set up these reports while the Marketer is able to analyze them without the possibility of someone editing a key report.
- An individual is tasked with implementing Localytics in a new application. While they own the creation of the application, the organization Admin should control which users are added. With the individual having the org-level permission of Creator, they can own the individual app-level permissions to make sure each user is granted access to only actions specific to their role, while the Admin still owns who it is that is being added to the instance of Localytics.
Manage your subscription from the Organization tab of Settings. Here you can edit your Organization name and see your active analytics and marketing subscriptions. You’ll also see a summary of your Billing method.
Localytics allows you to manage the Events and Attributes that are displayed within the Localytics interface. Use the Events tab of the Settings page to perform actions like renaming Events, disabling Events, disabling Event Attributes, or telling Localytics to treat numerical Attributes as numbers (rather than text).
When you rename Events, you are effectively assigning a different display name within Localytics; your event will still be tagged and named the same way within your code base, but for convenience Localytics allows you to alter the name that gets displayed within the dashboard. When you disable Events or Attributes, you are effectively telling Localytics to stop collecting this information on a forward-going basis. All historical data will be preserved and archived.
Localytics attempts to detect if the values that have been captured as an Event Attribute are numeric and, if so, it will attempt to display these as numeric values (rather than text). This means, for example, that we will visualize results by bucketing numeric values. This can be easily adjusted by toggling the on or off Enable Numeric Features, which is only visible for Event Attributes (not Events). To see all Event Attributes associated with an Event, select the carrot next to the Event name.
App owners can rename and add descriptions for Events in the Dashboard. On the Events tab of the Settings page, locate the Event you want to rename. Enter a new Event name under Display Name. Changing the display name of the Event changes its name throughout the Dashboard. It does not impact the processing of future Events, or change any historical data that has already been captured. The Event maintains its original name in S3.
Add a description under New Description. The description is displayed when the Event is viewed in the Events report within the Dashboard.
Treat Event Attributes as numbers or text
Event Attribute data can be treated as string or numeric for visualization purposes. On the Events tab of Settings, App owners can toggle on or off Enable Numeric Features to enable or disable numeric features, such as automatic bucketing and average and total metrics. Adjust this if we’ve incorrectly detected that an Event Attribute is numeric, or vice versa.
App owners have the power to permanently or temporarily turn off event tracking for specific events. Disabling an Event stops data collection for the Event and its Attributes as the data on a forward-going basis. Re-enabling an Event begins data collection again. However, Event data from the time the Event was first disabled to when it was re-enabled is not recoverable. A disabled Event’s history is hidden in the dashboard. Historical data is still accessible in S3.
To disable an Event, first select the correct app on the Events tab of Settings. You can select multiple apps but you must disable Events on the individual event level for each app that is selected, even if the same event name exists in multiple apps. Uncheck the box to disable the event.
Hide event attributes
App owners can hide Event Attributes to prevent their display in the Dashboard. When Attributes are hidden in the Dashboard, they are still pushed to S3 so there is no loss in data (in S3 only).
To hide an Event Attribute, expand the Event and deselect Enabled for the specified Attribute. The data is no longer stored in our system but is pushed to S3. If an Attribute is re-enabled, processing will resume, and the Dashboard will have a hole in data from the time the event was disabled. All Attributes for an active Event are still in S3 regardless of if they are disabled. Attributes cannot be renamed, only hidden.
On the Scheduled Reports tab of Settings, you will see a summary of the reports you have scheduled to be emailed to you. Wondering how to setup these daily emails? Complete this Project to learn how to get custom dashboards delivered right to your inbox.
Localytics has multiple APIs that allow you to programmatically access data or communicate data or instructions to Localytics. Our Analytics API is designed to allow you to programmatically extract data from Localytics. The Profiles & Push API is designed to allow you to communicate Profiles data to Localytics and/or instruct Localytics to send push messages on your behalf.
Analytics API key
Analytics API keys are user-specific and allow you to programmatically request analytics data via our API. The API is rate-limited to protect overall system health. To request an API key contact Localytics Support. Learn more about the Analytics API.
Profiles & Push API Key
Profiles & Push API keys are organization-wide. The Profiles API allows you to programmatically communicate user profile data to Localytics which can be used to create targeted Audiences and to power app engagement campaigns. Learn more about the Profiles API. The Push API allows you to send push messages programmatically. Learn more about the Push API.
Everyone forgets a password from time to time! If you need to reset yours, start at the login screen and select Forgot Password. Once you enter your email address, you’ll receive an email with instructions. Click the change your password link in the email to access the screen that will allow you to change your password. Finally, enter your new password. Once you’ve confirmed your new password, you're all set! Your password has been changed, and you're now signed in to the Dashboard.
Localytics provides the ability to export any custom-defined audience, or export profile data via our Export API. Audience Exports allows you to export Audiences you custom create in the Localytics Dashboard for any advanced integrations with other engagement platforms. Profile Exports allows you to bulk export various end-user preference and behavior profile attributes that you’ve tagged for use in other engagement or analysis tools.
Audiences and profiles must be enabled for export from within the Dashboard, and you can manage these exports via the Data Export tab under Settings. Audiences and Profiles that have been made available to the Data Export API can be disabled or re-enabled in this tab. An Enterprise Remarketing subscription is required to enable more than 5 Audiences at a time.