Create a behavior event
curl --request POST \
--url 'https://api.flashcat.cloud/rum/behavior-event/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"application_id": "app_3fK9mQ2xLp7VbN4cR8dW1y",
"description": "Buyer reached the order confirmation page after paying.",
"name": "Checkout completed",
"rules": [
{
"element": {
"by": "selector",
"op": "eq",
"value": "#pay-now"
},
"page": {
"op": "prefix",
"value": "/checkout"
},
"type": "click"
},
{
"name": "checkout_completed",
"type": "custom"
}
]
}
'import requests
url = "https://api.flashcat.cloud/rum/behavior-event/create?app_key="
payload = {
"application_id": "app_3fK9mQ2xLp7VbN4cR8dW1y",
"description": "Buyer reached the order confirmation page after paying.",
"name": "Checkout completed",
"rules": [
{
"element": {
"by": "selector",
"op": "eq",
"value": "#pay-now"
},
"page": {
"op": "prefix",
"value": "/checkout"
},
"type": "click"
},
{
"name": "checkout_completed",
"type": "custom"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
application_id: 'app_3fK9mQ2xLp7VbN4cR8dW1y',
description: 'Buyer reached the order confirmation page after paying.',
name: 'Checkout completed',
rules: [
{
element: {by: 'selector', op: 'eq', value: '#pay-now'},
page: {op: 'prefix', value: '/checkout'},
type: 'click'
},
{name: 'checkout_completed', type: 'custom'}
]
})
};
fetch('https://api.flashcat.cloud/rum/behavior-event/create?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/rum/behavior-event/create?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'application_id' => 'app_3fK9mQ2xLp7VbN4cR8dW1y',
'description' => 'Buyer reached the order confirmation page after paying.',
'name' => 'Checkout completed',
'rules' => [
[
'element' => [
'by' => 'selector',
'op' => 'eq',
'value' => '#pay-now'
],
'page' => [
'op' => 'prefix',
'value' => '/checkout'
],
'type' => 'click'
],
[
'name' => 'checkout_completed',
'type' => 'custom'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/rum/behavior-event/create?app_key="
payload := strings.NewReader("{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"description\": \"Buyer reached the order confirmation page after paying.\",\n \"name\": \"Checkout completed\",\n \"rules\": [\n {\n \"element\": {\n \"by\": \"selector\",\n \"op\": \"eq\",\n \"value\": \"#pay-now\"\n },\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/checkout\"\n },\n \"type\": \"click\"\n },\n {\n \"name\": \"checkout_completed\",\n \"type\": \"custom\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/rum/behavior-event/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"description\": \"Buyer reached the order confirmation page after paying.\",\n \"name\": \"Checkout completed\",\n \"rules\": [\n {\n \"element\": {\n \"by\": \"selector\",\n \"op\": \"eq\",\n \"value\": \"#pay-now\"\n },\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/checkout\"\n },\n \"type\": \"click\"\n },\n {\n \"name\": \"checkout_completed\",\n \"type\": \"custom\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/rum/behavior-event/create?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"description\": \"Buyer reached the order confirmation page after paying.\",\n \"name\": \"Checkout completed\",\n \"rules\": [\n {\n \"element\": {\n \"by\": \"selector\",\n \"op\": \"eq\",\n \"value\": \"#pay-now\"\n },\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/checkout\"\n },\n \"type\": \"click\"\n },\n {\n \"name\": \"checkout_completed\",\n \"type\": \"custom\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"created_at": 1779331200000,
"created_by": 80011,
"description": "Buyer reached the order confirmation page after paying.",
"event_id": "n3Q8kZvT2mRxW7cLpYbE4a",
"name": "Checkout completed",
"rules": [
{
"element": {
"by": "selector",
"op": "eq",
"value": "#pay-now"
},
"page": {
"op": "prefix",
"value": "/checkout"
},
"type": "click"
},
{
"name": "checkout_completed",
"type": "custom"
}
],
"status": "enabled",
"updated_at": 1780275600000,
"updated_by": 80042,
"version": 3
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "AccessDenied",
"message": "Access Denied."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}Behavior events
Create a behavior event
Save a new behavior event from a rule set and return it at version 1.
POST
/
rum
/
behavior-event
/
create
Create a behavior event
curl --request POST \
--url 'https://api.flashcat.cloud/rum/behavior-event/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"application_id": "app_3fK9mQ2xLp7VbN4cR8dW1y",
"description": "Buyer reached the order confirmation page after paying.",
"name": "Checkout completed",
"rules": [
{
"element": {
"by": "selector",
"op": "eq",
"value": "#pay-now"
},
"page": {
"op": "prefix",
"value": "/checkout"
},
"type": "click"
},
{
"name": "checkout_completed",
"type": "custom"
}
]
}
'import requests
url = "https://api.flashcat.cloud/rum/behavior-event/create?app_key="
payload = {
"application_id": "app_3fK9mQ2xLp7VbN4cR8dW1y",
"description": "Buyer reached the order confirmation page after paying.",
"name": "Checkout completed",
"rules": [
{
"element": {
"by": "selector",
"op": "eq",
"value": "#pay-now"
},
"page": {
"op": "prefix",
"value": "/checkout"
},
"type": "click"
},
{
"name": "checkout_completed",
"type": "custom"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
application_id: 'app_3fK9mQ2xLp7VbN4cR8dW1y',
description: 'Buyer reached the order confirmation page after paying.',
name: 'Checkout completed',
rules: [
{
element: {by: 'selector', op: 'eq', value: '#pay-now'},
page: {op: 'prefix', value: '/checkout'},
type: 'click'
},
{name: 'checkout_completed', type: 'custom'}
]
})
};
fetch('https://api.flashcat.cloud/rum/behavior-event/create?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/rum/behavior-event/create?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'application_id' => 'app_3fK9mQ2xLp7VbN4cR8dW1y',
'description' => 'Buyer reached the order confirmation page after paying.',
'name' => 'Checkout completed',
'rules' => [
[
'element' => [
'by' => 'selector',
'op' => 'eq',
'value' => '#pay-now'
],
'page' => [
'op' => 'prefix',
'value' => '/checkout'
],
'type' => 'click'
],
[
'name' => 'checkout_completed',
'type' => 'custom'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/rum/behavior-event/create?app_key="
payload := strings.NewReader("{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"description\": \"Buyer reached the order confirmation page after paying.\",\n \"name\": \"Checkout completed\",\n \"rules\": [\n {\n \"element\": {\n \"by\": \"selector\",\n \"op\": \"eq\",\n \"value\": \"#pay-now\"\n },\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/checkout\"\n },\n \"type\": \"click\"\n },\n {\n \"name\": \"checkout_completed\",\n \"type\": \"custom\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/rum/behavior-event/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"description\": \"Buyer reached the order confirmation page after paying.\",\n \"name\": \"Checkout completed\",\n \"rules\": [\n {\n \"element\": {\n \"by\": \"selector\",\n \"op\": \"eq\",\n \"value\": \"#pay-now\"\n },\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/checkout\"\n },\n \"type\": \"click\"\n },\n {\n \"name\": \"checkout_completed\",\n \"type\": \"custom\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/rum/behavior-event/create?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"application_id\": \"app_3fK9mQ2xLp7VbN4cR8dW1y\",\n \"description\": \"Buyer reached the order confirmation page after paying.\",\n \"name\": \"Checkout completed\",\n \"rules\": [\n {\n \"element\": {\n \"by\": \"selector\",\n \"op\": \"eq\",\n \"value\": \"#pay-now\"\n },\n \"page\": {\n \"op\": \"prefix\",\n \"value\": \"/checkout\"\n },\n \"type\": \"click\"\n },\n {\n \"name\": \"checkout_completed\",\n \"type\": \"custom\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"created_at": 1779331200000,
"created_by": 80011,
"description": "Buyer reached the order confirmation page after paying.",
"event_id": "n3Q8kZvT2mRxW7cLpYbE4a",
"name": "Checkout completed",
"rules": [
{
"element": {
"by": "selector",
"op": "eq",
"value": "#pay-now"
},
"page": {
"op": "prefix",
"value": "/checkout"
},
"type": "click"
},
{
"name": "checkout_completed",
"type": "custom"
}
],
"status": "enabled",
"updated_at": 1780275600000,
"updated_by": 80042,
"version": 3
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "AccessDenied",
"message": "Access Denied."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}{
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
},
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4"
}Restrictions
| Aspect | Value |
|---|---|
| Rate limits | 300 requests/minute; 20 requests/second per account |
| Permissions | Behavior Analytics Manage (rum) |
Usage
- Behavior events never rewrite stored data: rules are evaluated at query time, so a new or edited event applies to the whole retention window immediately.
namemust be unique within the application; a duplicate returnsInvalidParameter.- A
clickrule needs bothpageandelement; acustomrule needsname; 1 to 20 rules are allowed, and an application can hold at most 200 events. - The call is recorded in the account audit log.
Authorizations
Body
application/json
Save a new behavior event.
Response
Success
Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.
Was this page helpful?