Skip to main content
POST
/
v1
/
admin
/
fields
/
promote
Promote a field
curl --request POST \
  --url https://api.withsplendor.com/v1/admin/fields/promote \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-splendor-tenant-id: <x-splendor-tenant-id>' \
  --data '
{
  "dataset_id": "<string>",
  "field_path": "<string>",
  "tenant_id": "<string>"
}
'
{
  "field": {
    "dataset_id": "app-logs",
    "fast": true,
    "field_path": "latency_ms",
    "indexed": true,
    "seen_count": 1240000,
    "stored": true,
    "tenant_id": "acme",
    "type": "i64",
    "variants": [
      {
        "dataset_id": "app-logs",
        "fast": true,
        "field_path": "latency_ms",
        "indexed": true,
        "physical_field": "latency_ms_i64",
        "sample_value": "42",
        "seen_count": 1240000,
        "stored": true,
        "tenant_id": "acme",
        "value_type": "i64"
      }
    ]
  },
  "index_id": "acme__app-logs",
  "index_response": {},
  "promotion_id": "prom_1",
  "reindex_required": true,
  "status": "reindex_required",
  "target_generation_id": 5
}

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_id
string
required
field_path
string
required
Minimum string length: 1
tenant_id
string
required
value_type
enum<string> | null
Available options:
text,
keyword,
i64,
f64,
datetime,
bool,
ip

Response

Successful Response

field
FieldRegistryItem · object
required
index_id
string
required
index_response
Index Response · object
required
promotion_id
string
required
reindex_required
boolean
required
status
string
required
target_generation_id
integer
required