Skip to main content
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,
  "source": "ingestion_api",
  "access_type_filters": [
    "public"
  ],
  "last_status_filters": [
    "not_started"
  ],
  "docs_count_operator": ">",
  "docs_count_value": 123,
  "name_filter": "<string>",
  "source_to_page": {},
  "get_all_connectors": false
}
'
[
  {
    "source": "ingestion_api",
    "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>",
        "source": "ingestion_api",
        "access_type": "public",
        "cc_pair_status": "SCHEDULED",
        "in_progress": true,
        "in_repeated_error_state": true,
        "last_finished_status": "not_started",
        "last_status": "not_started",
        "last_success": "2023-11-07T05:31:56Z",
        "is_editable": true,
        "docs_indexed": 123,
        "latest_index_attempt_docs_indexed": 123
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Authorization header with Bearer token

Body

application/json
​
secondary_index
boolean
default:false
​
source
enum<string> | null
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
​
access_type_filters
enum<string>[]
Available options:
public,
private,
sync
​
last_status_filters
enum<string>[]
Available options:
not_started,
in_progress,
success,
canceled,
failed,
completed_with_errors
​
docs_count_operator
enum<string> | null
Available options:
>,
<,
=
​
docs_count_value
integer | null
​
name_filter
string | null
​
source_to_page
Source To Page · object
​
get_all_connectors
boolean
default:false

Response

Successful Response

​
source
enum<string>
required
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
​
summary
SourceSummary · object
required
​
current_page
integer
required
​
total_pages
integer
required
​
indexing_statuses
(ConnectorIndexingStatusLite · object | FederatedConnectorStatus · object)[]
required