Product API
Last updated
Was this helpful?
Last updated
Was this helpful?
From the product’s cloud instance, we get the following data
Unique User ID (email, Social, LinkedIn, GitHub, Username)
IP Address
Activity Details
Login Timestamp
We will be able to enrich the users using
email ID, GitHub, LinkedIn
IP Address
and find out the company to which the user belongs to. 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
PRODUCT_CLOUD
"PRODUCT_CLOUD"
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. If no data is available, activity type can be "CALL HOME"
string
Keys defined in metrics
"API KEY GENERATED"
environment (optional)
Environment where product has been deployed.
string
"production"
user_id_type (mandatory)
Type of user ID such as email, Social, LinkedIn, GitHub, Username.
enum
EMAIL, SOCIAL, LINKEDIN, GITHUB, USERNAME
"EMAIL"
user_id (mandatory)
Unique user ID captured for a customer.
string
"https://github.com/michaelbevan"
ip_addr (optional)
IP address of the system from where the user has logged in.
string
"192.127.0.0"
event_id (optional)
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.
string
"Mozilla/5.0 (Macintosh, Intel Mac OS X 10_15_7)...Safari/537.36"
meta (optional)
Any other parameter that needs to be sent.
object
