Estimate Custom Extractor Backfill
curl --request POST \
--url https://app.octavehq.com/api/v2/custom-extractor/backfill/estimate \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"extractorOId": "<string>",
"windowStart": "2023-11-07T05:31:56Z",
"windowEnd": "2023-11-07T05:31:56Z",
"billingMode": "CHARGE",
"billingBypassReason": "<string>",
"idempotencyKey": "<string>"
}
'import requests
url = "https://app.octavehq.com/api/v2/custom-extractor/backfill/estimate"
payload = {
"extractorOId": "<string>",
"windowStart": "2023-11-07T05:31:56Z",
"windowEnd": "2023-11-07T05:31:56Z",
"billingMode": "CHARGE",
"billingBypassReason": "<string>",
"idempotencyKey": "<string>"
}
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({
extractorOId: '<string>',
windowStart: '2023-11-07T05:31:56Z',
windowEnd: '2023-11-07T05:31:56Z',
billingMode: 'CHARGE',
billingBypassReason: '<string>',
idempotencyKey: '<string>'
})
};
fetch('https://app.octavehq.com/api/v2/custom-extractor/backfill/estimate', 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/estimate",
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([
'extractorOId' => '<string>',
'windowStart' => '2023-11-07T05:31:56Z',
'windowEnd' => '2023-11-07T05:31:56Z',
'billingMode' => 'CHARGE',
'billingBypassReason' => '<string>',
'idempotencyKey' => '<string>'
]),
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/estimate"
payload := strings.NewReader("{\n \"extractorOId\": \"<string>\",\n \"windowStart\": \"2023-11-07T05:31:56Z\",\n \"windowEnd\": \"2023-11-07T05:31:56Z\",\n \"billingMode\": \"CHARGE\",\n \"billingBypassReason\": \"<string>\",\n \"idempotencyKey\": \"<string>\"\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/estimate")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"extractorOId\": \"<string>\",\n \"windowStart\": \"2023-11-07T05:31:56Z\",\n \"windowEnd\": \"2023-11-07T05:31:56Z\",\n \"billingMode\": \"CHARGE\",\n \"billingBypassReason\": \"<string>\",\n \"idempotencyKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/custom-extractor/backfill/estimate")
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 \"extractorOId\": \"<string>\",\n \"windowStart\": \"2023-11-07T05:31:56Z\",\n \"windowEnd\": \"2023-11-07T05:31:56Z\",\n \"billingMode\": \"CHARGE\",\n \"billingBypassReason\": \"<string>\",\n \"idempotencyKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"eventCount": 123,
"creditCostPerEvent": 123,
"standardEstimatedCredits": 123,
"estimatedCredits": 123,
"creditsWillBeCharged": true,
"appliedFilterKeys": [
"<string>"
]
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Custom Extractors
Estimate Custom Extractor Backfill
Count the historical events selected by a saved custom extractor and estimate credits for an optional event-time window. This does not run the extractor, persist findings, create a job, or require the extractor to be ACTIVE. Use it before /custom-extractor/backfill/start. Requires the custom-extractors entitlement.
POST
/
api
/
v2
/
custom-extractor
/
backfill
/
estimate
Estimate Custom Extractor Backfill
curl --request POST \
--url https://app.octavehq.com/api/v2/custom-extractor/backfill/estimate \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"extractorOId": "<string>",
"windowStart": "2023-11-07T05:31:56Z",
"windowEnd": "2023-11-07T05:31:56Z",
"billingMode": "CHARGE",
"billingBypassReason": "<string>",
"idempotencyKey": "<string>"
}
'import requests
url = "https://app.octavehq.com/api/v2/custom-extractor/backfill/estimate"
payload = {
"extractorOId": "<string>",
"windowStart": "2023-11-07T05:31:56Z",
"windowEnd": "2023-11-07T05:31:56Z",
"billingMode": "CHARGE",
"billingBypassReason": "<string>",
"idempotencyKey": "<string>"
}
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({
extractorOId: '<string>',
windowStart: '2023-11-07T05:31:56Z',
windowEnd: '2023-11-07T05:31:56Z',
billingMode: 'CHARGE',
billingBypassReason: '<string>',
idempotencyKey: '<string>'
})
};
fetch('https://app.octavehq.com/api/v2/custom-extractor/backfill/estimate', 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/estimate",
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([
'extractorOId' => '<string>',
'windowStart' => '2023-11-07T05:31:56Z',
'windowEnd' => '2023-11-07T05:31:56Z',
'billingMode' => 'CHARGE',
'billingBypassReason' => '<string>',
'idempotencyKey' => '<string>'
]),
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/estimate"
payload := strings.NewReader("{\n \"extractorOId\": \"<string>\",\n \"windowStart\": \"2023-11-07T05:31:56Z\",\n \"windowEnd\": \"2023-11-07T05:31:56Z\",\n \"billingMode\": \"CHARGE\",\n \"billingBypassReason\": \"<string>\",\n \"idempotencyKey\": \"<string>\"\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/estimate")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"extractorOId\": \"<string>\",\n \"windowStart\": \"2023-11-07T05:31:56Z\",\n \"windowEnd\": \"2023-11-07T05:31:56Z\",\n \"billingMode\": \"CHARGE\",\n \"billingBypassReason\": \"<string>\",\n \"idempotencyKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/custom-extractor/backfill/estimate")
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 \"extractorOId\": \"<string>\",\n \"windowStart\": \"2023-11-07T05:31:56Z\",\n \"windowEnd\": \"2023-11-07T05:31:56Z\",\n \"billingMode\": \"CHARGE\",\n \"billingBypassReason\": \"<string>\",\n \"idempotencyKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"eventCount": 123,
"creditCostPerEvent": 123,
"standardEstimatedCredits": 123,
"estimatedCredits": 123,
"creditsWillBeCharged": true,
"appliedFilterKeys": [
"<string>"
]
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
application/json
Extractor reference plus the optional event-time window
Minimum string length:
1Inclusive event-time start; omit for all available history
Inclusive event-time end; omit to snapshot the job start time
Available options:
CHARGE, ADMIN_BYPASS Required string length:
10 - 2000Required string length:
8 - 128Pattern:
^[A-Za-z0-9._:-]+$