Telemetry Data
Last updated
Was this helpful?
Last updated
Was this helpful?
If you have an open source offering with call home/telemetry functionality to collect anonymous usage or event data, you can use the Product Usage API to share the data with Reo.Dev
From the telemetry data, we should be able to get
IP address of the system
Unique user ID
Activity Details
From the telemetry data, we will be able to enrich the
IP address and find out the company to which the user belongs
With the unique user ID, we will aggregate the product usage at a developer level and ultimately map it to the company to which the user(s) are associated
Header
Description
Data type
X-API-KEY
Generated Reo.Dev <API_KEY> for authorization.
string
Content-Type
Request content-type is always set to application/json.
string
To access your API key, navigate to:
Settings → Integrations → API Keys → Product Usage API
Admins can generate and copy the key
Non-admin users can only view and copy the existing key
source (Required)
Source of the activity.
enum
TELEMETRY, SAAS_PRODUCT
"TELEMETRY"
activity_type (Required)
Usage Metrics of the product. The definition of primary, secondary1 and secondary2 should match with metrics defined in the Reo.Dev settings. Where Source is Telemetry and you do not get any product usage data, activity type can be "CALL HOME"
string
Keys defined in metrics section in Reo.dev UI
"CALL HOME"
environment (optional)
Environment where product has been deployed.
string
"PRODUCTION"
user_id_type (optional)
Type of user ID such as email, Social, LinkedIn, GitHub, Username.
enum
EMAIL, SOCIAL, LINKEDIN, GITHUB, USERNAME
"EMAIL"
user_id (optional)
Unique user ID captured for a customer.
string
"https://github.com/michaelbevan"
ip_addr (mandatory)
IP address of the system from where the user has logged in.
string
"192.127.0.0"
event_id (mandatory)
A unique identifier for the event for Tenant for filter.
string
193ef456430
event_at (mandatory)
The time at which the event occurred (Formatted as a UNIX epoch in seconds).
integer
639303296
product_id (Required)
Unique identifier of your product.
string
"reoWebApp"
user_agent (optional)
Additional browser properties. This is optional if user_id is sent. In case user_id is not sent, user_agent becomes mandatory.
string
"Mozilla/5.0 (Macintosh, Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"
meta (optional)
Any other parameter that needs to be sent.
object
