Skip to main content
POST
/
v1
/
datasets
/
readiness
Check readiness for many datasets
curl --request POST \
  --url https://api.withsplendor.com/v1/datasets/readiness \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-splendor-tenant-id: <x-splendor-tenant-id>' \
  --data '
{
  "dataset_ids": [
    "<string>"
  ],
  "dataset_prefix": "<string>",
  "lifecycle_states": [
    "<string>"
  ],
  "statuses": [
    "<string>"
  ]
}
'
{
  "datasets": [
    {
      "dataset_id": "app-logs",
      "dataset_semantic_backlog_count": 0,
      "document_semantic_backlog_count": 0,
      "document_semantic_search_ready": true,
      "documents": {
        "expected": 1240000,
        "index_committed": 1240000,
        "parsed": 1240000,
        "schema_observed": 1240000,
        "semantic_embedded": 1240000,
        "semantic_total": 1240000
      },
      "ingest_run_count": 3,
      "lifecycle": {
        "reasons": [],
        "repairable": false,
        "state": "ready"
      },
      "ready_for": {
        "semantic_search": true,
        "sql_search": true,
        "text_search": true
      },
      "schema_ready": true,
      "semantic_configured": true,
      "semantic_search_ready": true,
      "status_counts": [
        {
          "count": 3,
          "status": "ready"
        }
      ],
      "text_search_ready": true,
      "vocabulary_semantic_backlog_count": 0,
      "vocabulary_semantic_ready": true
    }
  ]
}

Authorizations

Authorization
string
header
required

API token issued from the Splendor console.

Headers

x-splendor-tenant-id
string
required

Selects the tenant (workspace) the request acts within.

Body

application/json
dataset_ids
string[]
Maximum array length: 2000
dataset_prefix
string | null
Required string length: 1 - 128
lifecycle_states
string[]
Maximum array length: 16
statuses
string[]
Maximum array length: 16

Response

Successful Response

datasets
DatasetReadinessSummary · object[]
required