FAQ
Welcome to our FAQ page! Get answers to commonly asked questions about our services, policies, and more. Our comprehensive guide ensures a smooth and hassle-free experience for you.
What is the typical user journey when using the platform? How do users establish the connection with their wearable devices?
After clicking the "Connect X device" button, the user will be directed to the website of the data provider, where they will need to confirm permission to use their data. Once confirmed, the user will be redirected back to the app or website. It's possible to configure the postback option through the developer console.
What are the time and engineering resources required from our organization to integrate with the Spike API?
The resources required to integrate with Spike API will depend on a few factors, such as the complexity of your application, your team's familiarity with API integrations, and the specific features of the Spike API that you plan to use.
In general, you will need to allocate some time and engineering resources to:
- Review the Spike API documentation and understand its capabilities and limitations.
- Design the integration and identify which Spike API features you want to use.
- Develop the integration code to connect to the Spike API.
- Test the integration and ensure it meets your quality standards and requirements.
- Deploy the integration to your production environment and monitor it for any issues.
The amount of time and resources required for each step will depend on your specific situation. For example, if you have a team of experienced developers who have worked with APIs before, the integration process may be faster and require fewer resources. On the other hand, if you have a complex application and require a lot of customization, the integration process may take longer and require more engineering resources.
To get a better idea of the resources required for your specific integration, it's best to discuss your requirements with the Spike API team.
What is the process for initiating testing of the Spike API?
If you need to start testing Spike API, we recommend filling out the Contact Us form on our website.
What is the typical duration for transitioning to production when implementing the Spike API?
The time it takes to go to production with an integration of Spike API will depend on a few factors, such as the complexity of your application, the specific Spike API features you plan to use, and your team's experience with API integrations.
Generally speaking, the integration process can take anywhere from a few days to several weeks or months.
To get a more accurate estimate of the time it will take to go to production with your integration, it's best to work closely with the Spike API team.
Does your service offer real-time data streaming capabilities?
Yes, for Polar devices.
Could you provide clarification on the term "data standardization"?
When we say that data is "standardized," we mean that it has been transformed or processed in a way that makes it consistent, structured, and ready for analysis or use in the applications.
Standardization typically involves the application of a set of rules that define how data should be formatted, organized, and represented. These rules can vary depending on the type of data.
Do you offer assistance and support in terms of analytics and developing use cases?
Our machine learning (ML) service simplifies and accelerates the process of generating scores and predictions using data from wearable devices.
Is it possible to obtain historical data, such as data from the past six months?
To backfill metrics for users you can use this metrics endpoint to request data for specific inclusive range of days:
../metrics/{metric}?user_id={user-id}&start_date={start-date}&end_date={end-date}
The start-date and end date should have a maximum difference of 7 days, allowing for the retrieval of a week's worth of data in a single request.
For example these four request would fetch sleep data for user X for 2023-04-01 - 2023-04-28 dates:
/metrics/sleep?user_id=X&start_date=2023-04-01&end_date=2023-04-07
/metrics/sleep?user_id=X&start_date=2023-04-08&end_date=2023-04-14
/metrics/sleep?user_id=X&start_date=2023-04-15&end_date=2023-04-21
/metrics/sleep?user_id=X&start_date=2023-04-22&end_date=2023-04-28
Fitbit, Oura, Google Fit and Withings have no restrictions on backfilling data whereas Garmin only allows data to be backfilled upto 14 days. Whoop does not allow backfilling data.
At what frequency is data available for retrieval? Is it possible to obtain data every 5 minutes, hourly, or on a daily basis?
The frequency at which you can receive data from health and fitness tracking providers can vary depending on the specific platform and integration method you are using.
If you are using webhooks, data is typically delivered a few times per day. This means that you will receive updates and notifications periodically throughout the day, but not necessarily in real-time or at specific intervals like every 5 minutes or hourly.
Additionally, some providers may have rate limits on their pull data services. For example, Fitbit has a limit of 150 requests per hour per user.
It's important to note that the exact data delivery frequency and rate limits can vary depending on the provider and the specific integration setup. It's recommended to refer to the documentation or contact the provider directly to get precise information on data delivery intervals and any limitations that may apply.
Is it possible to obtain sample data for testing purposes?
Yes, please contact us at support@spikeapi.com and we will provide you sample data.
Is it possible for applications developed on no-code platforms to integrate with the Spike API?
Yes, it is possible for apps developed on no-code platforms to integrate with the Spike API, as long as the app does not require connectivity to Apple Health or Android Health data.
What if we need a custom integration/ an integration Spike doesn’t support yet? How long does it take to add it to the network?
Please contact us, it is very likely we are already developing this integration.
Do you provide a demo widget for use in the app?
No, but we can help to develop it.
How scalable is the infrastructure of Spike API? Can it effectively support a large number of users connecting through the API?
Yes, our infrastructure is highly scalable and capable of supporting large numbers of users connecting through the Spike API.
If you can't find what you're looking for, don't hesitate to reach out to our customer support team at support@spikeapi.com for personalized assistance. We value your feedback and strive to continuously improve our services based on your needs.