Control Custom Extractor Backfill
curl --request POST \
--url https://app.octavehq.com/api/v2/custom-extractor/backfill/control \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"oId": "cebj_1234567890"
}
'import requests
url = "https://app.octavehq.com/api/v2/custom-extractor/backfill/control"
payload = { "oId": "cebj_1234567890" }
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({oId: 'cebj_1234567890'})
};
fetch('https://app.octavehq.com/api/v2/custom-extractor/backfill/control', 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://app.octavehq.com/api/v2/custom-extractor/backfill/control",
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([
'oId' => 'cebj_1234567890'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$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://app.octavehq.com/api/v2/custom-extractor/backfill/control"
payload := strings.NewReader("{\n \"oId\": \"cebj_1234567890\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<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://app.octavehq.com/api/v2/custom-extractor/backfill/control")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"oId\": \"cebj_1234567890\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/custom-extractor/backfill/control")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"oId\": \"cebj_1234567890\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"status": "PENDING",
"customExtractorOId": "<string>",
"promptVersionAtStart": 1,
"requestFingerprint": "<string>",
"billingMode": "CHARGE",
"billingSurface": "IN_APP",
"createdAt": "2023-11-07T05:31:56Z",
"customExtractorName": "<string>",
"idempotencyKey": "<string>",
"windowStart": "2023-11-07T05:31:56Z",
"windowEnd": "2023-11-07T05:31:56Z",
"progress": {
"processedEvents": 123,
"findingsCreated": 123,
"failedEvents": 123,
"creditsSpent": 123,
"skippedEvents": 123,
"suppressedEvents": 123
},
"errorMessage": "<string>",
"circuitBreakerReason": "<string>",
"billingBypassReason": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"pausedAt": "2023-11-07T05:31:56Z"
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Custom Extractors
Control Custom Extractor Backfill
Pause, resume, or cancel a durable custom-extractor backfill job. Resume continues from the persisted cursor; it does not restart completed events. Requires the custom-extractors entitlement.
POST
/
api
/
v2
/
custom-extractor
/
backfill
/
control
Control Custom Extractor Backfill
curl --request POST \
--url https://app.octavehq.com/api/v2/custom-extractor/backfill/control \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"oId": "cebj_1234567890"
}
'import requests
url = "https://app.octavehq.com/api/v2/custom-extractor/backfill/control"
payload = { "oId": "cebj_1234567890" }
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({oId: 'cebj_1234567890'})
};
fetch('https://app.octavehq.com/api/v2/custom-extractor/backfill/control', 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://app.octavehq.com/api/v2/custom-extractor/backfill/control",
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([
'oId' => 'cebj_1234567890'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_key: <api-key>"
],
]);
$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://app.octavehq.com/api/v2/custom-extractor/backfill/control"
payload := strings.NewReader("{\n \"oId\": \"cebj_1234567890\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<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://app.octavehq.com/api/v2/custom-extractor/backfill/control")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"oId\": \"cebj_1234567890\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/custom-extractor/backfill/control")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"oId\": \"cebj_1234567890\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "<string>",
"status": "PENDING",
"customExtractorOId": "<string>",
"promptVersionAtStart": 1,
"requestFingerprint": "<string>",
"billingMode": "CHARGE",
"billingSurface": "IN_APP",
"createdAt": "2023-11-07T05:31:56Z",
"customExtractorName": "<string>",
"idempotencyKey": "<string>",
"windowStart": "2023-11-07T05:31:56Z",
"windowEnd": "2023-11-07T05:31:56Z",
"progress": {
"processedEvents": 123,
"findingsCreated": 123,
"failedEvents": 123,
"creditsSpent": 123,
"skippedEvents": 123,
"suppressedEvents": 123
},
"errorMessage": "<string>",
"circuitBreakerReason": "<string>",
"billingBypassReason": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"pausedAt": "2023-11-07T05:31:56Z"
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
application/json
Job oId plus the lifecycle action to apply