Ingest API

We recommend Ingest API v3. The rules below apply to v2 and v3. When you send events directly to the Ingest API, our server adds only a few fields:

• If the event has no sessionID, the server generates a new random sessionID for this event.
• If the event has no receivedAt property, the server sets it to the current date and time.
• If the event has no isTestMode property, the server sets it to "false".
• The server adds the property TelemetryDeck.API.Ingest.version with the value of the API version you used.

For these events, our server does not look at the IP address at all. So no country, continent or other location value is added. We use the IP address only for Website Analytics, which sends its events to the "/v2/w/" endpoint.

Yes. Events that you send directly to the Ingest API are treated the same way as events from our SDKs. The same security, deletion and contractual commitments apply.

One difference is important: Our SDKs salt and hash the clientUser value already on the device. Then our servers salt and hash it a second time, for complete anonymization. If you send events directly to the Ingest API, the on-device step is missing. So it is your responsibility that no identifying data gets into the clientUser property.

Yes. We recommend Ingest API v3. The required fields are appID, clientUser and type. The API returns a 422 error when a field is missing or wrong.

There are no rate limits. We still recommend that you send events in batches. Single requests keep the radio of the device busy and drain the battery. Our SDKs do this batching for you.

The ingest host nom.telemetrydeck.com is located in Helsinki, Finland.