Facet Queries

Generated facet queries operations.

DELETE/v1/facet-queries/{id}Release a facet preparation handleread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: cancel_facet_query

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

204Success

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternalrevision_mismatchstale_continuationsearch_busymetadata_unavailabledatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/facet-queries/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/facet-queries/{id}Read a facet preparation or its ready windowread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_facet_query

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

200Successapplication/json

Example

{
  "field": "string",
  "kind": "simple-keyset",
  "revision": "r12",
  "total": 0,
  "totalIsLowerBound": false,
  "values": [
    {
      "count": 0,
      "countIsLowerBound": true,
      "label": "string",
      "seriesId": "id_8h2k4q",
      "value": "string"
    }
  ],
  "variant": "window",
  "window": {
    "basis": "string",
    "limit": 1,
    "next": "string",
    "previous": "string",
    "queryId": "id_8h2k4q",
    "reload": "string",
    "returned": 0
  }
}

Schema

fieldstringrequired
kind"simple-keyset"required
revisionstringrequired
totalintegerrequired≥ 0
totalIsLowerBoundfalserequired
valuesarray of objectrequired0–200 items
- countintegerrequired
- countIsLowerBoundbooleanrequired
- labelstringrequired
- seriesIdstringpattern ^[A-Za-z0-9_-]{43}$
- valuestringrequired
variant"window"required
windowobjectrequired
- basisstringrequired
- limitintegerrequired1–200
- nextstringlength 1–512pattern ^[A-Za-z0-9_-]+$
- previousstringlength 1–512pattern ^[A-Za-z0-9_-]+$
- queryIdstringrequiredlength 1–512pattern ^[A-Za-z0-9_-]+$
- reloadstringlength 1–512pattern ^[A-Za-z0-9_-]+$
- returnedintegerrequired0–200

202Successapplication/json

Example

{
  "kind": "facet-preparing",
  "queryId": "id_8h2k4q",
  "retryAfterMs": 1800000,
  "state": "preparing",
  "variant": "preparing"
}

Schema

kind"facet-preparing"required
queryIdstringrequiredlength 1–512pattern ^[A-Za-z0-9_-]+$
retryAfterMsintegerrequired≥ 1
state"preparing"required
variant"preparing"required

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternalrevision_mismatchstale_continuationsearch_busymetadata_unavailabledatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/facet-queries/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"