Create a data-intelligence action
curl --request POST \
--url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"enabled": true,
"event_name": "event_name",
"intelligence_provider": "EMAIL_AGE",
"profile_risk_update_interval": {
"nano": 1,
"negative": true,
"positive": true,
"seconds": 1,
"units": [
{
"dateBased": true,
"duration": "PT42S",
"durationEstimated": true,
"timeBased": true
}
],
"zero": true
},
"quality": "ALWAYS"
}
'import requests
url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences"
payload = {
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"enabled": True,
"event_name": "event_name",
"intelligence_provider": "EMAIL_AGE",
"profile_risk_update_interval": {
"nano": 1,
"negative": True,
"positive": True,
"seconds": 1,
"units": [
{
"dateBased": True,
"duration": "PT42S",
"durationEstimated": True,
"timeBased": True
}
],
"zero": True
},
"quality": "ALWAYS"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
enabled: true,
event_name: 'event_name',
intelligence_provider: 'EMAIL_AGE',
profile_risk_update_interval: {
nano: 1,
negative: true,
positive: true,
seconds: 1,
units: [{dateBased: true, duration: 'PT42S', durationEstimated: true, timeBased: true}],
zero: true
},
quality: 'ALWAYS'
})
};
fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences', 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.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences",
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([
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'enabled' => true,
'event_name' => 'event_name',
'intelligence_provider' => 'EMAIL_AGE',
'profile_risk_update_interval' => [
'nano' => 1,
'negative' => true,
'positive' => true,
'seconds' => 1,
'units' => [
[
'dateBased' => true,
'duration' => 'PT42S',
'durationEstimated' => true,
'timeBased' => true
]
],
'zero' => true
],
'quality' => 'ALWAYS'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences"
payload := strings.NewReader("{\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"enabled\": true,\n \"event_name\": \"event_name\",\n \"intelligence_provider\": \"EMAIL_AGE\",\n \"profile_risk_update_interval\": {\n \"nano\": 1,\n \"negative\": true,\n \"positive\": true,\n \"seconds\": 1,\n \"units\": [\n {\n \"dateBased\": true,\n \"duration\": \"PT42S\",\n \"durationEstimated\": true,\n \"timeBased\": true\n }\n ],\n \"zero\": true\n },\n \"quality\": \"ALWAYS\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"enabled\": true,\n \"event_name\": \"event_name\",\n \"intelligence_provider\": \"EMAIL_AGE\",\n \"profile_risk_update_interval\": {\n \"nano\": 1,\n \"negative\": true,\n \"positive\": true,\n \"seconds\": 1,\n \"units\": [\n {\n \"dateBased\": true,\n \"duration\": \"PT42S\",\n \"durationEstimated\": true,\n \"timeBased\": true\n }\n ],\n \"zero\": true\n },\n \"quality\": \"ALWAYS\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"enabled\": true,\n \"event_name\": \"event_name\",\n \"intelligence_provider\": \"EMAIL_AGE\",\n \"profile_risk_update_interval\": {\n \"nano\": 1,\n \"negative\": true,\n \"positive\": true,\n \"seconds\": 1,\n \"units\": [\n {\n \"dateBased\": true,\n \"duration\": \"PT42S\",\n \"durationEstimated\": true,\n \"timeBased\": true\n }\n ],\n \"zero\": true\n },\n \"quality\": \"ALWAYS\"\n}"
response = http.request(request)
puts response.read_body{
"action_id": "<string>",
"action_type": "DATA_INTELLIGENCE",
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"enabled": true,
"event_name": "<string>",
"profile_risk_update_interval": {
"nano": 123,
"negative": true,
"positive": true,
"seconds": 123,
"units": [
{
"dateBased": true,
"duration": "PT42S",
"durationEstimated": true,
"timeBased": true
}
],
"zero": true
}
}Campaign Controllers Actions
Create a data-intelligence action
Adds a data-intelligence action to the specified campaign controller. When the controller’s triggers fire, this action sends the participant’s event data to the Data Intelligence pipeline for ML scoring. Returns the created data-intelligence action with its server-assigned id.
POST
/
v2
/
campaigns
/
{campaignId}
{version}
/
controllers
/
{controllerId}
/
actions
/
data-intelligences
Create a data-intelligence action
curl --request POST \
--url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"component_ids": [
"component_id"
],
"component_references": [
{
"component_id": "component_id",
"socket_names": [
"socket_name"
]
}
],
"enabled": true,
"event_name": "event_name",
"intelligence_provider": "EMAIL_AGE",
"profile_risk_update_interval": {
"nano": 1,
"negative": true,
"positive": true,
"seconds": 1,
"units": [
{
"dateBased": true,
"duration": "PT42S",
"durationEstimated": true,
"timeBased": true
}
],
"zero": true
},
"quality": "ALWAYS"
}
'import requests
url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences"
payload = {
"component_ids": ["component_id"],
"component_references": [
{
"component_id": "component_id",
"socket_names": ["socket_name"]
}
],
"enabled": True,
"event_name": "event_name",
"intelligence_provider": "EMAIL_AGE",
"profile_risk_update_interval": {
"nano": 1,
"negative": True,
"positive": True,
"seconds": 1,
"units": [
{
"dateBased": True,
"duration": "PT42S",
"durationEstimated": True,
"timeBased": True
}
],
"zero": True
},
"quality": "ALWAYS"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
component_ids: ['component_id'],
component_references: [{component_id: 'component_id', socket_names: ['socket_name']}],
enabled: true,
event_name: 'event_name',
intelligence_provider: 'EMAIL_AGE',
profile_risk_update_interval: {
nano: 1,
negative: true,
positive: true,
seconds: 1,
units: [{dateBased: true, duration: 'PT42S', durationEstimated: true, timeBased: true}],
zero: true
},
quality: 'ALWAYS'
})
};
fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences', 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.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences",
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([
'component_ids' => [
'component_id'
],
'component_references' => [
[
'component_id' => 'component_id',
'socket_names' => [
'socket_name'
]
]
],
'enabled' => true,
'event_name' => 'event_name',
'intelligence_provider' => 'EMAIL_AGE',
'profile_risk_update_interval' => [
'nano' => 1,
'negative' => true,
'positive' => true,
'seconds' => 1,
'units' => [
[
'dateBased' => true,
'duration' => 'PT42S',
'durationEstimated' => true,
'timeBased' => true
]
],
'zero' => true
],
'quality' => 'ALWAYS'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences"
payload := strings.NewReader("{\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"enabled\": true,\n \"event_name\": \"event_name\",\n \"intelligence_provider\": \"EMAIL_AGE\",\n \"profile_risk_update_interval\": {\n \"nano\": 1,\n \"negative\": true,\n \"positive\": true,\n \"seconds\": 1,\n \"units\": [\n {\n \"dateBased\": true,\n \"duration\": \"PT42S\",\n \"durationEstimated\": true,\n \"timeBased\": true\n }\n ],\n \"zero\": true\n },\n \"quality\": \"ALWAYS\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"enabled\": true,\n \"event_name\": \"event_name\",\n \"intelligence_provider\": \"EMAIL_AGE\",\n \"profile_risk_update_interval\": {\n \"nano\": 1,\n \"negative\": true,\n \"positive\": true,\n \"seconds\": 1,\n \"units\": [\n {\n \"dateBased\": true,\n \"duration\": \"PT42S\",\n \"durationEstimated\": true,\n \"timeBased\": true\n }\n ],\n \"zero\": true\n },\n \"quality\": \"ALWAYS\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/data-intelligences")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"component_ids\": [\n \"component_id\"\n ],\n \"component_references\": [\n {\n \"component_id\": \"component_id\",\n \"socket_names\": [\n \"socket_name\"\n ]\n }\n ],\n \"enabled\": true,\n \"event_name\": \"event_name\",\n \"intelligence_provider\": \"EMAIL_AGE\",\n \"profile_risk_update_interval\": {\n \"nano\": 1,\n \"negative\": true,\n \"positive\": true,\n \"seconds\": 1,\n \"units\": [\n {\n \"dateBased\": true,\n \"duration\": \"PT42S\",\n \"durationEstimated\": true,\n \"timeBased\": true\n }\n ],\n \"zero\": true\n },\n \"quality\": \"ALWAYS\"\n}"
response = http.request(request)
puts response.read_body{
"action_id": "<string>",
"action_type": "DATA_INTELLIGENCE",
"component_ids": [
"<string>"
],
"component_references": [
{
"component_id": "<string>",
"socket_names": [
"<string>"
]
}
],
"enabled": true,
"event_name": "<string>",
"profile_risk_update_interval": {
"nano": 123,
"negative": true,
"positive": true,
"seconds": 123,
"units": [
{
"dateBased": true,
"duration": "PT42S",
"durationEstimated": true,
"timeBased": true
}
],
"zero": true
}
}Authorizations
HEADERQUERYCOOKIE
Path Parameters
Pattern:
(/version/.+)?Body
application/json
Show child attributes
Show child attributes
Choose between static or dynamic enabled
Choose between static or dynamic event name
intelligence_provider
Static Value · enum<string>Buildtime - Handlebars · stringBuildtime - Javascript · string
Choose between static or dynamic intelligence provider
Available options:
EMAIL_AGE, MAXMIND, NOOP profile_risk_update_interval
Static Value · Static Value · objectBuildtime - Handlebars · stringBuildtime - Javascript · string
Choose between static or dynamic profile risk update interval
Show child attributes
Show child attributes
Available options:
ALWAYS, HIGH, LOW Response
Successful response
Available options:
DATA_INTELLIGENCE Show child attributes
Show child attributes
The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.
Available options:
ALWAYS, HIGH, LOW The event name as configured: a literal value, or an expression (type:string) when defined dynamically.
intelligence_provider
Static Value · enum<string>Buildtime - Handlebars · stringBuildtime - Javascript · string
The intelligence provider as configured: a literal value, or an expression (type:string) when defined dynamically.
Available options:
EMAIL_AGE, MAXMIND, NOOP profile_risk_update_interval
Static Value · Static Value · objectBuildtime - Handlebars · stringBuildtime - Javascript · string
The profile risk update interval as configured: a literal value, or an expression (type:string) when defined dynamically.
Show child attributes
Show child attributes
⌘I