Ingest an external funnel event
curl --request POST \
--url https://api.aura-app.ai/v1/funnel/events \
--header 'Content-Type: application/json' \
--data '
{
"eventId": "<string>",
"funnelId": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"pagePath": "<string>",
"sourceDomain": "<string>",
"version": 1,
"visitorId": "<string>",
"attribution": {
"fbclid": "<string>",
"gclid": "<string>",
"referrer": "<string>",
"utmCampaign": "<string>",
"utmContent": "<string>",
"utmMedium": "<string>",
"utmSource": "<string>",
"utmTerm": "<string>"
},
"gpc": true,
"identity": {
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>"
},
"previousPage": "<string>",
"properties": {}
}
'import requests
url = "https://api.aura-app.ai/v1/funnel/events"
payload = {
"eventId": "<string>",
"funnelId": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"pagePath": "<string>",
"sourceDomain": "<string>",
"version": 1,
"visitorId": "<string>",
"attribution": {
"fbclid": "<string>",
"gclid": "<string>",
"referrer": "<string>",
"utmCampaign": "<string>",
"utmContent": "<string>",
"utmMedium": "<string>",
"utmSource": "<string>",
"utmTerm": "<string>"
},
"gpc": True,
"identity": {
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>"
},
"previousPage": "<string>",
"properties": {}
}
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({
eventId: '<string>',
funnelId: '<string>',
occurredAt: '2023-11-07T05:31:56Z',
pagePath: '<string>',
sourceDomain: '<string>',
version: 1,
visitorId: '<string>',
attribution: {
fbclid: '<string>',
gclid: '<string>',
referrer: '<string>',
utmCampaign: '<string>',
utmContent: '<string>',
utmMedium: '<string>',
utmSource: '<string>',
utmTerm: '<string>'
},
gpc: true,
identity: {
email: 'jsmith@example.com',
firstName: '<string>',
lastName: '<string>',
phone: '<string>'
},
previousPage: '<string>',
properties: {}
})
};
fetch('https://api.aura-app.ai/v1/funnel/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.aura-app.ai/v1/funnel/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([
'eventId' => '<string>',
'funnelId' => '<string>',
'occurredAt' => '2023-11-07T05:31:56Z',
'pagePath' => '<string>',
'sourceDomain' => '<string>',
'version' => 1,
'visitorId' => '<string>',
'attribution' => [
'fbclid' => '<string>',
'gclid' => '<string>',
'referrer' => '<string>',
'utmCampaign' => '<string>',
'utmContent' => '<string>',
'utmMedium' => '<string>',
'utmSource' => '<string>',
'utmTerm' => '<string>'
],
'gpc' => true,
'identity' => [
'email' => 'jsmith@example.com',
'firstName' => '<string>',
'lastName' => '<string>',
'phone' => '<string>'
],
'previousPage' => '<string>',
'properties' => [
]
]),
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.aura-app.ai/v1/funnel/events"
payload := strings.NewReader("{\n \"eventId\": \"<string>\",\n \"funnelId\": \"<string>\",\n \"occurredAt\": \"2023-11-07T05:31:56Z\",\n \"pagePath\": \"<string>\",\n \"sourceDomain\": \"<string>\",\n \"version\": 1,\n \"visitorId\": \"<string>\",\n \"attribution\": {\n \"fbclid\": \"<string>\",\n \"gclid\": \"<string>\",\n \"referrer\": \"<string>\",\n \"utmCampaign\": \"<string>\",\n \"utmContent\": \"<string>\",\n \"utmMedium\": \"<string>\",\n \"utmSource\": \"<string>\",\n \"utmTerm\": \"<string>\"\n },\n \"gpc\": true,\n \"identity\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"previousPage\": \"<string>\",\n \"properties\": {}\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.aura-app.ai/v1/funnel/events")
.header("Content-Type", "application/json")
.body("{\n \"eventId\": \"<string>\",\n \"funnelId\": \"<string>\",\n \"occurredAt\": \"2023-11-07T05:31:56Z\",\n \"pagePath\": \"<string>\",\n \"sourceDomain\": \"<string>\",\n \"version\": 1,\n \"visitorId\": \"<string>\",\n \"attribution\": {\n \"fbclid\": \"<string>\",\n \"gclid\": \"<string>\",\n \"referrer\": \"<string>\",\n \"utmCampaign\": \"<string>\",\n \"utmContent\": \"<string>\",\n \"utmMedium\": \"<string>\",\n \"utmSource\": \"<string>\",\n \"utmTerm\": \"<string>\"\n },\n \"gpc\": true,\n \"identity\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"previousPage\": \"<string>\",\n \"properties\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aura-app.ai/v1/funnel/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 \"eventId\": \"<string>\",\n \"funnelId\": \"<string>\",\n \"occurredAt\": \"2023-11-07T05:31:56Z\",\n \"pagePath\": \"<string>\",\n \"sourceDomain\": \"<string>\",\n \"version\": 1,\n \"visitorId\": \"<string>\",\n \"attribution\": {\n \"fbclid\": \"<string>\",\n \"gclid\": \"<string>\",\n \"referrer\": \"<string>\",\n \"utmCampaign\": \"<string>\",\n \"utmContent\": \"<string>\",\n \"utmMedium\": \"<string>\",\n \"utmSource\": \"<string>\",\n \"utmTerm\": \"<string>\"\n },\n \"gpc\": true,\n \"identity\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"previousPage\": \"<string>\",\n \"properties\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"accepted": true,
"duplicate": true,
"sessionId": "<string>"
},
"success": true
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}Funnel
Ingest an external funnel event
POST
/
v1
/
funnel
/
events
Ingest an external funnel event
curl --request POST \
--url https://api.aura-app.ai/v1/funnel/events \
--header 'Content-Type: application/json' \
--data '
{
"eventId": "<string>",
"funnelId": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"pagePath": "<string>",
"sourceDomain": "<string>",
"version": 1,
"visitorId": "<string>",
"attribution": {
"fbclid": "<string>",
"gclid": "<string>",
"referrer": "<string>",
"utmCampaign": "<string>",
"utmContent": "<string>",
"utmMedium": "<string>",
"utmSource": "<string>",
"utmTerm": "<string>"
},
"gpc": true,
"identity": {
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>"
},
"previousPage": "<string>",
"properties": {}
}
'import requests
url = "https://api.aura-app.ai/v1/funnel/events"
payload = {
"eventId": "<string>",
"funnelId": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"pagePath": "<string>",
"sourceDomain": "<string>",
"version": 1,
"visitorId": "<string>",
"attribution": {
"fbclid": "<string>",
"gclid": "<string>",
"referrer": "<string>",
"utmCampaign": "<string>",
"utmContent": "<string>",
"utmMedium": "<string>",
"utmSource": "<string>",
"utmTerm": "<string>"
},
"gpc": True,
"identity": {
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>"
},
"previousPage": "<string>",
"properties": {}
}
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({
eventId: '<string>',
funnelId: '<string>',
occurredAt: '2023-11-07T05:31:56Z',
pagePath: '<string>',
sourceDomain: '<string>',
version: 1,
visitorId: '<string>',
attribution: {
fbclid: '<string>',
gclid: '<string>',
referrer: '<string>',
utmCampaign: '<string>',
utmContent: '<string>',
utmMedium: '<string>',
utmSource: '<string>',
utmTerm: '<string>'
},
gpc: true,
identity: {
email: 'jsmith@example.com',
firstName: '<string>',
lastName: '<string>',
phone: '<string>'
},
previousPage: '<string>',
properties: {}
})
};
fetch('https://api.aura-app.ai/v1/funnel/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.aura-app.ai/v1/funnel/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([
'eventId' => '<string>',
'funnelId' => '<string>',
'occurredAt' => '2023-11-07T05:31:56Z',
'pagePath' => '<string>',
'sourceDomain' => '<string>',
'version' => 1,
'visitorId' => '<string>',
'attribution' => [
'fbclid' => '<string>',
'gclid' => '<string>',
'referrer' => '<string>',
'utmCampaign' => '<string>',
'utmContent' => '<string>',
'utmMedium' => '<string>',
'utmSource' => '<string>',
'utmTerm' => '<string>'
],
'gpc' => true,
'identity' => [
'email' => 'jsmith@example.com',
'firstName' => '<string>',
'lastName' => '<string>',
'phone' => '<string>'
],
'previousPage' => '<string>',
'properties' => [
]
]),
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.aura-app.ai/v1/funnel/events"
payload := strings.NewReader("{\n \"eventId\": \"<string>\",\n \"funnelId\": \"<string>\",\n \"occurredAt\": \"2023-11-07T05:31:56Z\",\n \"pagePath\": \"<string>\",\n \"sourceDomain\": \"<string>\",\n \"version\": 1,\n \"visitorId\": \"<string>\",\n \"attribution\": {\n \"fbclid\": \"<string>\",\n \"gclid\": \"<string>\",\n \"referrer\": \"<string>\",\n \"utmCampaign\": \"<string>\",\n \"utmContent\": \"<string>\",\n \"utmMedium\": \"<string>\",\n \"utmSource\": \"<string>\",\n \"utmTerm\": \"<string>\"\n },\n \"gpc\": true,\n \"identity\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"previousPage\": \"<string>\",\n \"properties\": {}\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.aura-app.ai/v1/funnel/events")
.header("Content-Type", "application/json")
.body("{\n \"eventId\": \"<string>\",\n \"funnelId\": \"<string>\",\n \"occurredAt\": \"2023-11-07T05:31:56Z\",\n \"pagePath\": \"<string>\",\n \"sourceDomain\": \"<string>\",\n \"version\": 1,\n \"visitorId\": \"<string>\",\n \"attribution\": {\n \"fbclid\": \"<string>\",\n \"gclid\": \"<string>\",\n \"referrer\": \"<string>\",\n \"utmCampaign\": \"<string>\",\n \"utmContent\": \"<string>\",\n \"utmMedium\": \"<string>\",\n \"utmSource\": \"<string>\",\n \"utmTerm\": \"<string>\"\n },\n \"gpc\": true,\n \"identity\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"previousPage\": \"<string>\",\n \"properties\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aura-app.ai/v1/funnel/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 \"eventId\": \"<string>\",\n \"funnelId\": \"<string>\",\n \"occurredAt\": \"2023-11-07T05:31:56Z\",\n \"pagePath\": \"<string>\",\n \"sourceDomain\": \"<string>\",\n \"version\": 1,\n \"visitorId\": \"<string>\",\n \"attribution\": {\n \"fbclid\": \"<string>\",\n \"gclid\": \"<string>\",\n \"referrer\": \"<string>\",\n \"utmCampaign\": \"<string>\",\n \"utmContent\": \"<string>\",\n \"utmMedium\": \"<string>\",\n \"utmSource\": \"<string>\",\n \"utmTerm\": \"<string>\"\n },\n \"gpc\": true,\n \"identity\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"previousPage\": \"<string>\",\n \"properties\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"accepted": true,
"duplicate": true,
"sessionId": "<string>"
},
"success": true
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}Body
application/json
Available options:
granted, not_required Available options:
mobile, tablet, desktop, unknown Required string length:
8 - 128Available options:
page_view, engaged_visit, cta_click, form_start, booking_open, lead_submission, booking_completion, purchase_completion, purchase_refund Required string length:
1 - 128Maximum string length:
2000Required string length:
1 - 253Available options:
1 Required string length:
8 - 128Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
2000Show child attributes
Show child attributes