Monitors
Create Monitor
Create a new scheduled enrichment monitor.
POST
/
api
/
agent
/
monitors
Create Monitor
curl --request POST \
--url https://encrata.com/api/agent/monitors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"monitor_type": "<string>",
"emails": [
"<string>"
],
"frequency": "<string>",
"change_detection": "<string>",
"data_source_type": "<string>",
"data_source_ref": "<string>"
}
'import requests
url = "https://encrata.com/api/agent/monitors"
payload = {
"name": "<string>",
"monitor_type": "<string>",
"emails": ["<string>"],
"frequency": "<string>",
"change_detection": "<string>",
"data_source_type": "<string>",
"data_source_ref": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
monitor_type: '<string>',
emails: ['<string>'],
frequency: '<string>',
change_detection: '<string>',
data_source_type: '<string>',
data_source_ref: '<string>'
})
};
fetch('https://encrata.com/api/agent/monitors', 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://encrata.com/api/agent/monitors",
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([
'name' => '<string>',
'monitor_type' => '<string>',
'emails' => [
'<string>'
],
'frequency' => '<string>',
'change_detection' => '<string>',
'data_source_type' => '<string>',
'data_source_ref' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://encrata.com/api/agent/monitors"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"monitor_type\": \"<string>\",\n \"emails\": [\n \"<string>\"\n ],\n \"frequency\": \"<string>\",\n \"change_detection\": \"<string>\",\n \"data_source_type\": \"<string>\",\n \"data_source_ref\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://encrata.com/api/agent/monitors")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"monitor_type\": \"<string>\",\n \"emails\": [\n \"<string>\"\n ],\n \"frequency\": \"<string>\",\n \"change_detection\": \"<string>\",\n \"data_source_type\": \"<string>\",\n \"data_source_ref\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://encrata.com/api/agent/monitors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"monitor_type\": \"<string>\",\n \"emails\": [\n \"<string>\"\n ],\n \"frequency\": \"<string>\",\n \"change_detection\": \"<string>\",\n \"data_source_type\": \"<string>\",\n \"data_source_ref\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthentication
Requires an API key in theAuthorization header.
Authorization: Bearer YOUR_API_KEY
Request
string
required
A display name for the monitor.
string
The type of targets to monitor. Default:
email.Valid values: email, phone, domain, ipstring[]
List of email addresses to monitor. Required when
monitor_type is email.string
How often to run enrichment. Default:
monthly.Valid values: weekly, biweekly, monthly, quarterlystring
Detection mode. Default:
diff_only.Valid values: diff_only, full_refreshstring
Where targets come from. Default:
csv.Valid values: csv, liststring
Reference to a contact list ID when
data_source_type is list.Example: Email monitor
curl -X POST https://encrata.com/api/monitors \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"name": "Engineering team",
"monitor_type": "email",
"emails": ["satya@microsoft.com", "sundar@google.com"],
"frequency": "monthly",
"change_detection": "diff_only"
}'
Response
Returns the created monitor object.{
"id": "a1b2c3d4-...",
"name": "Engineering team",
"monitor_type": "email",
"frequency": "monthly",
"change_detection": "diff_only",
"status": "active",
"tracked_fields": [],
"target_count": 2,
"next_run_at": "2026-05-22T12:00:00Z",
"created_at": "2026-05-15T12:00:00Z"
}
Was this page helpful?
⌘I
Create Monitor
curl --request POST \
--url https://encrata.com/api/agent/monitors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"monitor_type": "<string>",
"emails": [
"<string>"
],
"frequency": "<string>",
"change_detection": "<string>",
"data_source_type": "<string>",
"data_source_ref": "<string>"
}
'import requests
url = "https://encrata.com/api/agent/monitors"
payload = {
"name": "<string>",
"monitor_type": "<string>",
"emails": ["<string>"],
"frequency": "<string>",
"change_detection": "<string>",
"data_source_type": "<string>",
"data_source_ref": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
monitor_type: '<string>',
emails: ['<string>'],
frequency: '<string>',
change_detection: '<string>',
data_source_type: '<string>',
data_source_ref: '<string>'
})
};
fetch('https://encrata.com/api/agent/monitors', 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://encrata.com/api/agent/monitors",
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([
'name' => '<string>',
'monitor_type' => '<string>',
'emails' => [
'<string>'
],
'frequency' => '<string>',
'change_detection' => '<string>',
'data_source_type' => '<string>',
'data_source_ref' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://encrata.com/api/agent/monitors"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"monitor_type\": \"<string>\",\n \"emails\": [\n \"<string>\"\n ],\n \"frequency\": \"<string>\",\n \"change_detection\": \"<string>\",\n \"data_source_type\": \"<string>\",\n \"data_source_ref\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://encrata.com/api/agent/monitors")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"monitor_type\": \"<string>\",\n \"emails\": [\n \"<string>\"\n ],\n \"frequency\": \"<string>\",\n \"change_detection\": \"<string>\",\n \"data_source_type\": \"<string>\",\n \"data_source_ref\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://encrata.com/api/agent/monitors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"monitor_type\": \"<string>\",\n \"emails\": [\n \"<string>\"\n ],\n \"frequency\": \"<string>\",\n \"change_detection\": \"<string>\",\n \"data_source_type\": \"<string>\",\n \"data_source_ref\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body