Entity Ingestion Config API
List Entity Ingestion Runs
List the ingestion runs for an entity ingestion config, most-recent-first, including status, per-item counts, and any failure. Use to verify that ingested data landed.
GET
/
v2
/
entity-ingestion-configs
/
{ingestion_config_id}
/
runs
List Entity Ingestion Runs
curl --request GET \
--url https://public.api.serval.com/v2/entity-ingestion-configs/{ingestion_config_id}/runs \
--header 'Authorization: Bearer <token>'import requests
url = "https://public.api.serval.com/v2/entity-ingestion-configs/{ingestion_config_id}/runs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://public.api.serval.com/v2/entity-ingestion-configs/{ingestion_config_id}/runs', 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://public.api.serval.com/v2/entity-ingestion-configs/{ingestion_config_id}/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://public.api.serval.com/v2/entity-ingestion-configs/{ingestion_config_id}/runs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://public.api.serval.com/v2/entity-ingestion-configs/{ingestion_config_id}/runs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/entity-ingestion-configs/{ingestion_config_id}/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"ingestionConfigId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"itemsAddedCount": 123,
"itemsUpdatedCount": 123,
"itemsDeletedCount": 123,
"itemsUnchangedCount": 123,
"itemsErroredCount": 123,
"failureMessage": "<string>",
"svRunId": "<string>",
"isFullSync": true
}
]
}{
"message": "<string>",
"detail": {
"type": "<string>",
"value": "<string>",
"debug": {}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ingestion config whose runs to list.
Query Parameters
Maximum number of runs to return. Default is 10, maximum is 50.
Number of runs to skip (for pagination).
Response
Success
The ingestion runs, most-recent-first.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
List Entity Ingestion Runs
curl --request GET \
--url https://public.api.serval.com/v2/entity-ingestion-configs/{ingestion_config_id}/runs \
--header 'Authorization: Bearer <token>'import requests
url = "https://public.api.serval.com/v2/entity-ingestion-configs/{ingestion_config_id}/runs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://public.api.serval.com/v2/entity-ingestion-configs/{ingestion_config_id}/runs', 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://public.api.serval.com/v2/entity-ingestion-configs/{ingestion_config_id}/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://public.api.serval.com/v2/entity-ingestion-configs/{ingestion_config_id}/runs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://public.api.serval.com/v2/entity-ingestion-configs/{ingestion_config_id}/runs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/entity-ingestion-configs/{ingestion_config_id}/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"ingestionConfigId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"itemsAddedCount": 123,
"itemsUpdatedCount": 123,
"itemsDeletedCount": 123,
"itemsUnchangedCount": 123,
"itemsErroredCount": 123,
"failureMessage": "<string>",
"svRunId": "<string>",
"isFullSync": true
}
]
}{
"message": "<string>",
"detail": {
"type": "<string>",
"value": "<string>",
"debug": {}
}
}
