Frequently asked questions
Can’t find the answer you’re looking for? Ask a question on Github issues or write an email to info@ this domain!
- Can I use TelemetryDeck for my Website? My Android App? My app for [platform x]?
TelemetryDeck supports multi-platform integration! All TelemetryDeck Events are sent via HTTP
POSTrequest, so you can send them from a web page, or any other app for any platform. For websites we provide a single line of code so you can get started instantly, and our SDKs are super lightweight and help you send signals from the get-go.We're providing SDKs for Swift, Kotlin, JavaScript, and more!
If you would like to see other client packages, open an issue or (if you want to be particularly awesome) maybe write one yourself and share it with us and the community? Here's a spec document to get you started.
- What licenses are applicable to my code?
The SDK code included in your app is licensed under a modified MIT License with a removed attribution clause. This means you can use it in any project without restriction, and you do not have to attribute it.
- What is an Event?
A TelemetryDeck Event is the most basic building block in the TelemetryDeck analytics ecosystem. Every time an event happens in your app, you can send an event using the
TelemetryManager.send(...)function.Events have a type which is the name of the signal such as
TelemetryDeck.Navigation.pathChanged, a user which is a String representation of a hashed user identifier, plus a parameters which are various metadata, such asTelemetryDeck.Device.operatingSystem,TelemetryDeck.RunContext.language, or custom metadata you want to deliver with each event.Events are the raw data that is being interpreted by your analytics.
- Will I lose data if I downgrade plans?
No, you will not lose data if you go from a more expensive to a cheaper or free plan. There are however two things to keep in mind: retention and restrictions.
Retention is how long we keep data on our live calculation servers so that you can run queries against it. If your plan has 24 months of retention, you can query any data that that time period. Data collected before that time is not gone, but it is not accessible to you. If you switch from a plan with 24 months to one with 3 months retention, you will lose access to a lot of your data. If you switch back to a paid plan, this data will be available to you again.
Restrictions are the maximum number of events your organization can receive on your account before the system will stop collecting data for you. On free plans, because there are no automatic upgrades, your account gets restricted immediately after you reach the included number of events, meaning that data collection is stopped and and incoming data is discarded. This data is actually lost and can’t be recovered, which is why we’ll warn you once you use up 80% of that budget.
- What is data retention?
In TelemetryDeck plans, retention is the period of time where we keep your data actively loaded on our calculation servers to be ready for your queries. If you have 24 months of retention, you can display and query all data from 24 months ago to today.
Data outside this time period is not deleted, but it gets unloaded from our calculation servers and kept in cold storage, where it can be retrieved if the included retention time in your plan changes.
- Is there a hard usage limit for plans?
Even though TelemetryDeck’s paid plans include a max number of events per month, we won’t stop collecting data at that point, but you will be upgraded to a higher plan if you cross that threshold two months in a row.
However, to protect against runaway processes, very large spikes, and other unforeseen consequences, there are also restriction limits: if you send over 20 times the amount of events included in your paid plan, your account will stop collecting any data until the end of the month. Events sent to our APIs will be discarded in that mode and are not recoverable.
This is of course very drastic, so we’ll send multiple warning emails before you reach that point.
- Can I upgrade later?
You can upgrade your plan at any time, and we'll prorate the price difference. The system will also auto-upgrade you if you go over your included events too many times in a row.
- I don't know how many users I have
Welcome to the analytics journey! Our recommendation is to start with the smallest paid plan and add only the most basic analytics. This will allow you to estimate your costs better.
If you use more data than is covered by the smallest plan, it will auto-upgrade after two months.
- What happens when I go over my events per month?
We'll warn you at 80% and 100% usage via email, but events are still ingested. We'll upgrade your plan to the next fitting plan if this happens for two months in a row.
- Should I create multiple apps?
We recommend one TelemetryDeck App per codebase. This makes it easy for you to separate different concerns and dashboards so you're just analyzing the code that you want at one time.
Additional apps don't incur any extra costs because they are grouped under your Organization, and the Usage dashboard will show you which apps use the most of your included evens.
- What about sudden spikes?
Congrats, you're featured on the App Store! If your spike is temporary, you'll probably run into your plan limit, and if you are way over your limit, we may decide to pause processing your data for a bit.
However, one single spike won't increase your costs. To make sure we're growing organically with you, we'll only upgrade your plan if you're over the limit two months in a row.
Also, talk to us, we'll find something.
- How many Events do I need?
That depends a lot on the number of users you have, the type of your app (websites are way less chatty), and how much data you're collecting. When you send a TelemetryDeck event every other line in your code, your usage will be higher than if you only send one at app launch.
A good starting point is Number of Usersx30. You can also play around with our Pricing Calculator for a better estimation.
- Can I have a custom plan?
For sure! Contact us at info@telemetrydeck.com and we'll help you find the perfect solution for your needs!