Overview

Everything you need to get started with the Userflux APIs.

👋 Introduction

Welcome to the Userflux API reference notebook. This contains API collections that you can use to quickly test out the Userflux APIs with your own account.

The APIs consist of requests for fetching and updating user profiles, calling the Metrics API, as well as ingesting new user events into the platform.

📒 API Variables

To try out the APIs, there are two variables you need to supply in order to make API requests:

• integrationApiKey - you will need to fill this in with your own API Key in order to authenticate yourself. You can access your API keys from the "Developers" section of the web dashboard.

• userId - you will need to fill this in also. Specify a unique User ID associated with the user you want to make changes to.

📒 Additional Notes

• the timestamp field in the ingest user event request is in epoch milliseconds format. You can leave it null to auto-generate with the current time.

🛟 Help and support

If you have any questions or suggestions, please don't hesitate to reach out via email at [e-mail]