Get Connector Indexing Status
curl --request POST \
--url https://cloud.onyx.app/api/manage/admin/connector/indexing-status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"secondary_index": false,
"access_type_filters": [],
"last_status_filters": [],
"docs_count_value": 123,
"name_filter": "<string>",
"source_to_page": {},
"get_all_connectors": false
}
'import requests
url = "https://cloud.onyx.app/api/manage/admin/connector/indexing-status"
payload = {
"secondary_index": False,
"access_type_filters": [],
"last_status_filters": [],
"docs_count_value": 123,
"name_filter": "<string>",
"source_to_page": {},
"get_all_connectors": False
}
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({
secondary_index: false,
access_type_filters: [],
last_status_filters: [],
docs_count_value: 123,
name_filter: '<string>',
source_to_page: {},
get_all_connectors: false
})
};
fetch('https://cloud.onyx.app/api/manage/admin/connector/indexing-status', 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://cloud.onyx.app/api/manage/admin/connector/indexing-status",
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([
'secondary_index' => false,
'access_type_filters' => [
],
'last_status_filters' => [
],
'docs_count_value' => 123,
'name_filter' => '<string>',
'source_to_page' => [
],
'get_all_connectors' => false
]),
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://cloud.onyx.app/api/manage/admin/connector/indexing-status"
payload := strings.NewReader("{\n \"secondary_index\": false,\n \"access_type_filters\": [],\n \"last_status_filters\": [],\n \"docs_count_value\": 123,\n \"name_filter\": \"<string>\",\n \"source_to_page\": {},\n \"get_all_connectors\": false\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://cloud.onyx.app/api/manage/admin/connector/indexing-status")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"secondary_index\": false,\n \"access_type_filters\": [],\n \"last_status_filters\": [],\n \"docs_count_value\": 123,\n \"name_filter\": \"<string>\",\n \"source_to_page\": {},\n \"get_all_connectors\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.onyx.app/api/manage/admin/connector/indexing-status")
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 \"secondary_index\": false,\n \"access_type_filters\": [],\n \"last_status_filters\": [],\n \"docs_count_value\": 123,\n \"name_filter\": \"<string>\",\n \"source_to_page\": {},\n \"get_all_connectors\": false\n}"
response = http.request(request)
puts response.read_body[
{
"summary": {
"total_connectors": 123,
"active_connectors": 123,
"public_connectors": 123,
"total_docs_indexed": 123
},
"current_page": 123,
"total_pages": 123,
"indexing_statuses": [
{
"cc_pair_id": 123,
"name": "<string>",
"in_progress": true,
"in_repeated_error_state": true,
"last_success": "2023-11-07T05:31:56Z",
"is_editable": true,
"docs_indexed": 123,
"latest_index_attempt_docs_indexed": 123
}
]
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Connectors
Get Connector Indexing Status
POST
/
manage
/
admin
/
connector
/
indexing-status
Get Connector Indexing Status
curl --request POST \
--url https://cloud.onyx.app/api/manage/admin/connector/indexing-status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"secondary_index": false,
"access_type_filters": [],
"last_status_filters": [],
"docs_count_value": 123,
"name_filter": "<string>",
"source_to_page": {},
"get_all_connectors": false
}
'import requests
url = "https://cloud.onyx.app/api/manage/admin/connector/indexing-status"
payload = {
"secondary_index": False,
"access_type_filters": [],
"last_status_filters": [],
"docs_count_value": 123,
"name_filter": "<string>",
"source_to_page": {},
"get_all_connectors": False
}
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({
secondary_index: false,
access_type_filters: [],
last_status_filters: [],
docs_count_value: 123,
name_filter: '<string>',
source_to_page: {},
get_all_connectors: false
})
};
fetch('https://cloud.onyx.app/api/manage/admin/connector/indexing-status', 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://cloud.onyx.app/api/manage/admin/connector/indexing-status",
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([
'secondary_index' => false,
'access_type_filters' => [
],
'last_status_filters' => [
],
'docs_count_value' => 123,
'name_filter' => '<string>',
'source_to_page' => [
],
'get_all_connectors' => false
]),
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://cloud.onyx.app/api/manage/admin/connector/indexing-status"
payload := strings.NewReader("{\n \"secondary_index\": false,\n \"access_type_filters\": [],\n \"last_status_filters\": [],\n \"docs_count_value\": 123,\n \"name_filter\": \"<string>\",\n \"source_to_page\": {},\n \"get_all_connectors\": false\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://cloud.onyx.app/api/manage/admin/connector/indexing-status")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"secondary_index\": false,\n \"access_type_filters\": [],\n \"last_status_filters\": [],\n \"docs_count_value\": 123,\n \"name_filter\": \"<string>\",\n \"source_to_page\": {},\n \"get_all_connectors\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.onyx.app/api/manage/admin/connector/indexing-status")
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 \"secondary_index\": false,\n \"access_type_filters\": [],\n \"last_status_filters\": [],\n \"docs_count_value\": 123,\n \"name_filter\": \"<string>\",\n \"source_to_page\": {},\n \"get_all_connectors\": false\n}"
response = http.request(request)
puts response.read_body[
{
"summary": {
"total_connectors": 123,
"active_connectors": 123,
"public_connectors": 123,
"total_docs_indexed": 123
},
"current_page": 123,
"total_pages": 123,
"indexing_statuses": [
{
"cc_pair_id": 123,
"name": "<string>",
"in_progress": true,
"in_repeated_error_state": true,
"last_success": "2023-11-07T05:31:56Z",
"is_editable": true,
"docs_indexed": 123,
"latest_index_attempt_docs_indexed": 123
}
]
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Authorization header with Bearer token
Body
application/json
Available options:
ingestion_api, slack, web, google_drive, gmail, requesttracker, github, gitbook, gitlab, guru, bookstack, outline, confluence, jira, slab, productboard, file, coda, notion, zulip, linear, hubspot, document360, gong, google_sites, zendesk, loopio, dropbox, sharepoint, teams, salesforce, discourse, axero, clickup, mediawiki, wikipedia, asana, s3, r2, google_cloud_storage, oci_storage, xenforo, not_applicable, discord, freshdesk, fireflies, egnyte, airtable, highspot, drupal_wiki, imap, bitbucket, testrail, mock_connector, user_file Available options:
public, private, sync Available options:
not_started, in_progress, success, canceled, failed, completed_with_errors Available options:
>, <, = Show child attributes
Show child attributes
Response
Successful Response
Available options:
ingestion_api, slack, web, google_drive, gmail, requesttracker, github, gitbook, gitlab, guru, bookstack, outline, confluence, jira, slab, productboard, file, coda, notion, zulip, linear, hubspot, document360, gong, google_sites, zendesk, loopio, dropbox, sharepoint, teams, salesforce, discourse, axero, clickup, mediawiki, wikipedia, asana, s3, r2, google_cloud_storage, oci_storage, xenforo, not_applicable, discord, freshdesk, fireflies, egnyte, airtable, highspot, drupal_wiki, imap, bitbucket, testrail, mock_connector, user_file Show child attributes
Show child attributes
indexing_statuses
(ConnectorIndexingStatusLite · object | FederatedConnectorStatus · object)[]
required
- ConnectorIndexingStatusLite
- FederatedConnectorStatus
Show child attributes
Show child attributes
Was this page helpful?
⌘I