Analytics Events
Send instrumented event data into Fullstory
Domain-specific events captured by Fullstory add additional intelligence when you're searching across sessions and creating new user segments. You can define and capture these events with Fullstory custom events.
Parameters
name String required
A String containing the name of the event. Event names can be no longer than 250 characters.
properties Map<String, ?> optional
A map containing additional information about the event that will be indexed by Fullstory. The maximum size is 512Kb.
Limits
- Sustained calls are limited to 60 calls per minute, with a burst limit of 40 calls per second.
- Arrays of objects will not be indexed (arrays of strings and numbers will be indexed).
Additional Information
- Java
- Kotlin
public static void FS.event(String name, Map<String, ?> properties);
Example Invocation
Adding a product to an e-commerce cart
Map<String, Object> eventProperties = new HashMap<String, Object>() {
{
put("cart_id_str", "130983678493");
put("product_id_str", "798ith22928347");
put("sku_str", "L-100");
put("category_str", "Clothing");
put("name_str", "Button Front Cardigan");
put("brand_str", "Bright & Bold");
put("variant_str", "Blue");
put("price_real", 58.99);
put("quantity_real", 1);
put("coupon_str", "25OFF");
put("position_int", 3);
put("url_str", "https://www.example.com/product/path");
put("image_url_str", "https://www.example.com/product/path.jpg");
}
};
FS.event("Product Added", eventProperties);
SaaS product subscription
Map<String, Object> eventProperties = new HashMap<String, Object>() {
{
put("uid_str", "750948353");
put("plan_name_str", "Professional");
put("plan_price_real", 299);
put("plan_users_int", 10);
put("days_in_trial_int", 42);
put("feature_packs", new String[]{"MAPS", "DEV", "DATA"});
}
};
FS.event("Subscribed", eventProperties);
fun FS.event(name: String, properties: Map<String, *>): Unit
Example Invocation
Adding a product to an e-commerce cart
val eventProperties = mapOf(
"cart_id_str" to "130983678493",
"product_id_str" to "798ith22928347",
"sku_str" to "L-100",
"category_str" to "Clothing",
"name_str" to "Button Front Cardigan",
"brand_str" to "Bright & Bold",
"variant_str" to "Blue",
"price_real" to 58.99,
"quantity_real" to 1,
"coupon_str" to "25OFF",
"position_int" to 3,
"url_str" to "https://www.example.com/product/path",
"image_url_str" to "https://www.example.com/product/path.jpg",
)
FS.event("Product Added", eventProperties)
SaaS product subscription
val eventProperties = mapOf(
"uid_str" to "750948353",
"plan_name_str" to "Professional",
"plan_price_real" to 299,
"plan_users_int" to 10,
"days_in_trial_int" to 42,
"feature_packs" to arrayOf("MAPS", "DEV", "DATA"),
)
FS.event("Subscribed", eventProperties)