Heartpingr is a powerful platform that helps you track your heartbeat events and gain insights into the health and wellness of your APIs and services.
This guide will walk you through the basics of setting up and using Heartpingr to create your first tracking event.
Want to skip all this and just talk to us?
If you want to skip all this and just talk to us, click here to get in touch with our team.
We can help you set up your account, create your first event, and answer any questions you may have.
If you prefer to do it yourself, keep reading for a step-by-step guide on how to get started with Heartpingr.
Step 1: Setup Your Account
Getting started with Heartpingr is simple and takes just a few minutes.
To begin, you'll need to create an account. Choose from one of our tiers and login to get access to your dashboard.
Account Types
Free Tier
Perfect for beginners and trying the platform
Paid Tiers
Our paid tiers provide higher rate limits and advanced alerting
Custom
A customized package specific for your needs along with dedicated support
Step 2: Create Your First Event
Tracking your first event is as easy as a POST.
Update your API or SaaS with the following command:
curl -X POST https://api.heartpingr.maplerope.com \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_API_KEY" \
-d '{
"action": "heartbeat",
"eventId": "my_sample_event_id",
"sum": {
"my_sample_attribute": 123
}
}'
Replace the YOUR_API_KEY with your actual API key, and my_sample_event_id with a unique identifier for your
event.
The sum field is optional and can be used to send additional data related to the event. You can include any number of
attributes in the sum object. and Heartpingr will aggregate them.
For both the eventId and sum attributes, only lowercase alphanumeric characters, underscores, and periods are allowed. The eventId must be unique for each event you want to track.
The Heartpingr API will respond with the following payload, providing a real-time snapshot on the usage for the event and attributes specified.
{
"hour": number,
"day": number,
"month": number,
"year": number,
"sum": {
"my_sample_attribute": {
"hour": number,
"day": number,
"month": number,
"year": number
}
}
}
Step 3: Watch Your Dashboard
Your dashboard will automatically update as events flow in
If your API is set up correctly, you should see your event appear in the dashboard shortly after sending the request.
Step 4: Setting Up Alerts
Heartpingr can notify you when your services go above a certain threshold or are below a certain threshold after a given time period.
Alerts fire when your API or service is not performing as expected. You can set up alerts in cases where the event count for a specific event ID is above a certain threshold.
To set up an alert, go to your Dashboard and edit an event. You can set the metric for the alert, the threshold that must be breached, the time period to check (hour, day, month, or year), and the notification methods (email, webhook, or SMS) your use case requires. All alerts fire within 60-90 seconds of the threshold being breached, providing a semi-real time alerting system for your applications.
Note that the POST made for alerts will provide a real-time usage count for the event ID, so you can see how many times the event has been triggered in the last hour, day, month, or year, and perform a more instant failsafe action, if needed.
Ready to Get Started for Free?
Track your first event in minutes and start gaining insights into your API usage.