Skip to content
Docs menu: Getting started

Getting started

Pulse receives signals: small events your app sends when something happens. This page takes you from nothing to a first chart.

1. Create an app

Sign in with an email code and create an app. The app gets an app key. The key identifies the app; it is not a secret and it ships inside your build. One key is enough: you use the same key while you develop and in the app you ship.

2. Send a signal

Use an SDK, or send the request yourself. Replace APP_KEY with the key of your app.

Swift

import MightySPulse

Pulse.initialize(appKey: "APP_KEY")
Pulse.track("level.complete")

Kotlin

import dev.mightys.pulse.Pulse

Pulse.initialize(this, "APP_KEY")
Pulse.track("level.complete")

Flutter

import 'package:mightys_pulse/mightys_pulse.dart';

await Pulse.initialize('APP_KEY');
Pulse.track('level.complete');

Unity (C#)

using Mightys.Pulse;

Pulse.Initialize("APP_KEY");
Pulse.Track("level.complete");

JavaScript

import { Pulse } from "@mightys-dev/pulse/web";

Pulse.init("APP_KEY", { appVersion: "1.0.0" });
Pulse.track("level.complete", { props: { level: 3 } });

.NET (C#)

using Mightys.Pulse;

Pulse.Initialize("APP_KEY");
Pulse.Track("level.complete");

HTTP

curl -X POST https://in.mightys.dev/api/v1/signals \
  -H "X-App-Key: APP_KEY" \
  -H "Content-Type: application/json" \
  -d '[{"timestamp":"2026-11-13T08:00:00Z","type":"level.complete"}]'

How to install each SDK, and all of its options, is on its own page: see SDKs in the docs menu.

The HTTP example needs a current timestamp. A signal older than 30 days or more than one hour in the future is rejected.

3. See it arrive

After you create an app, the app waits for the first signal and shows each step: waiting, signal received, stored, in your chart. If nothing arrives, it tells you which step did not happen.

A signal from a development build is a test signal. It appears in the charts when Test mode is on, and it never mixes into the numbers of your released app.

How Test mode works

What a signal carries

Only timestamp and type are required. Everything else is optional.

Fields of a signal
FieldRequiredMeaning
timestampYesWhen it happened, with a UTC marker or a time zone offset.
typeYesThe name of the signal, up to 200 characters.
sessionIdNoA random ID for the session. Without it the signal is not counted in sessions.
userHashNoAn identifier you hashed on the device. The server hashes it again with a salt that belongs to your app.
valueNoOne number, for example a duration or an amount.
debugNoTrue for test builds. The SDKs set it for you. Debug signals are kept apart from release data and show under Test mode.
systemNoplatform, osName, osVersion, appVersion, appBuildNumber, deviceModel, locale, sdkName, sdkVersion.
propsNoYour own keys with text or number values. No nested objects.

Limits of one request

  • A request body is at most 1,048,576 bytes and holds at most 1000 signals.
  • The props of one signal are at most 8192 bytes as JSON.
  • One invalid or oversized signal rejects the whole request, so nothing is half stored.

What the endpoint answers

Response codes of the ingest endpoint
StatusMeaning
202The request was accepted. Signals over your plan limit are not stored; collection resumes when the period resets.
400The JSON is invalid or a field has the wrong type.
401The app key is missing or unknown.
413The body, the props or the batch is too large.
429Too many requests for this app. Retry after one second.
503The server cannot take signals right now. Retry later.

A 202 is not a receipt

It means the signal was accepted into memory. Writing to storage follows a moment later, and the app shows that step separately.