curl --request POST \
--url https://api.widgetic.com/embed/workflows/{workflowId}/events \
--header 'Content-Type: application/json' \
--data '
{
"versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"token": "Example token",
"events": [],
"heights": []
}
'import requests
url = "https://api.widgetic.com/embed/workflows/{workflowId}/events"
payload = {
"versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"token": "Example token",
"events": [],
"heights": []
}
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({
versionId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
token: 'Example token',
events: [],
heights: []
})
};
fetch('https://api.widgetic.com/embed/workflows/{workflowId}/events', 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.widgetic.com/embed/workflows/{workflowId}/events",
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([
'versionId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
'token' => 'Example token',
'events' => [
],
'heights' => [
]
]),
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.widgetic.com/embed/workflows/{workflowId}/events"
payload := strings.NewReader("{\n \"versionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"token\": \"Example token\",\n \"events\": [],\n \"heights\": []\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.widgetic.com/embed/workflows/{workflowId}/events")
.header("Content-Type", "application/json")
.body("{\n \"versionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"token\": \"Example token\",\n \"events\": [],\n \"heights\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.widgetic.com/embed/workflows/{workflowId}/events")
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 \"versionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"token\": \"Example token\",\n \"events\": [],\n \"heights\": []\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"recorded": true,
"counters": 42,
"reason": "Example reason"
},
"meta": {
"page": 1,
"size": 20,
"total": 135,
"limit": 20,
"offset": 0,
"hasNextPage": true,
"hasPreviousPage": false,
"nextCursor": "<string>",
"warnings": [
"<string>"
]
}
}{
"success": true,
"data": {
"recorded": true,
"counters": 42,
"reason": "Example reason"
},
"meta": {
"page": 1,
"size": 20,
"total": 135,
"limit": 20,
"offset": 0,
"hasNextPage": true,
"hasPreviousPage": false,
"nextCursor": "<string>",
"warnings": [
"<string>"
]
}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}Report what visitors did in a Workflow, as counts
Public report of counts for a workflow, sent by the embed. No API key. Each event is one id and a number: a visitor reached a block (n), took a connection (e), or could not be moved on (f). Nothing else is kept: no visitor, no value a visitor typed, no address. A batch carries at most 100 events and 16 KB. The same report may carry heights: how tall a step settled at in the browser, which the embed code of the workflow uses to start its box at a real height (a composition, a whole number of pixels, nothing about the visitor).
A report is accepted only with the token the workflow’s own read handed out for that versionId, so a page that never read the workflow cannot raise its numbers. An expired token (EVENT_TOKEN_EXPIRED) is refused with 401: read the workflow again for a new one. Counts for ids that are not in that version, or for a workflow that is not live, are not recorded and the answer says so (recorded: false) with 200: the visitor’s page has nothing to fix.
The body is JSON, sent as application/json or as text/plain (a “simple” cross-origin request, which is what lets a report leave a page that is being closed).
Address. https://api.widgetic.com/embed/workflows/{workflowId}/events: the root of the API host, NOT under /v1. A client generated from this description for https://api.widgetic.com/v1 must be given the base address https://api.widgetic.com for the calls of the Public Embed tag.
curl --request POST \
--url https://api.widgetic.com/embed/workflows/{workflowId}/events \
--header 'Content-Type: application/json' \
--data '
{
"versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"token": "Example token",
"events": [],
"heights": []
}
'import requests
url = "https://api.widgetic.com/embed/workflows/{workflowId}/events"
payload = {
"versionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"token": "Example token",
"events": [],
"heights": []
}
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({
versionId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
token: 'Example token',
events: [],
heights: []
})
};
fetch('https://api.widgetic.com/embed/workflows/{workflowId}/events', 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.widgetic.com/embed/workflows/{workflowId}/events",
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([
'versionId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
'token' => 'Example token',
'events' => [
],
'heights' => [
]
]),
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.widgetic.com/embed/workflows/{workflowId}/events"
payload := strings.NewReader("{\n \"versionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"token\": \"Example token\",\n \"events\": [],\n \"heights\": []\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.widgetic.com/embed/workflows/{workflowId}/events")
.header("Content-Type", "application/json")
.body("{\n \"versionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"token\": \"Example token\",\n \"events\": [],\n \"heights\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.widgetic.com/embed/workflows/{workflowId}/events")
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 \"versionId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"token\": \"Example token\",\n \"events\": [],\n \"heights\": []\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"recorded": true,
"counters": 42,
"reason": "Example reason"
},
"meta": {
"page": 1,
"size": 20,
"total": 135,
"limit": 20,
"offset": 0,
"hasNextPage": true,
"hasPreviousPage": false,
"nextCursor": "<string>",
"warnings": [
"<string>"
]
}
}{
"success": true,
"data": {
"recorded": true,
"counters": 42,
"reason": "Example reason"
},
"meta": {
"page": 1,
"size": 20,
"total": 135,
"limit": 20,
"offset": 0,
"hasNextPage": true,
"hasPreviousPage": false,
"nextCursor": "<string>",
"warnings": [
"<string>"
]
}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}{
"success": true,
"message": "Example message",
"code": "NOT_FOUND",
"details": {},
"correlationId": "Example correlationId",
"error": {}
}Path Parameters
Body
One report from a visitor's browser: counts (events), the heights steps settled at (heights), or both. A report
with neither is refused.
The eventToken of the workflow, read for the same version.
The counts of what visitors did. At least one of events and heights is needed.
100Show child attributes
Show child attributes
How tall steps of this version settled in the visitor's browser, so that the embed code of the workflow can
start its box at the height visitors saw instead of a guess. The Embed SDK sends one for a visitor who has no
remembered height for the step. The gateway keeps the latest few for each composition (the median is what the
code gets); a composition that this version does not show is left out. At least one of events and heights
is needed.
10Show child attributes
Show child attributes
Response
Nothing was counted or kept (recorded is false, with the reason)
Show child attributes
Show child attributes
{
"recorded": true,
"counters": 42,
"reason": "Example reason"
}
Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat.
Show child attributes
Show child attributes