Field API (v1)

Fields

Create field

Creates a new field in the index of the target Coveo Cloud organization.

Required privilege: Fields - Create

Privilege required

{"owner":"PLATFORM","targetDomain":"FIELD","type":"CREATE","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
automaticFacetsCandidate
boolean

Whether this field is to be considered by the facet generator feature.
Default: true if a facet or multivalue facet field.

dateFormat
string

A regex indicating the date format, for some date type fields.
Example: %Y/%m/%d@%H:%M:%S%G

description
string

A description of the field.
Example: The date of creation of a given item

facet
boolean

Whether Group By operations and Facet requests can be performed on the field.
Default:
- false for STRING type fields.
- true for all other types of fields.

hierarchicalFacet
boolean

Whether the field contains multiple values that form a hierarchy (see also the multiValueFacetTokenizers property).
Note: Applicable to field type STRING only.
Default: false

includeInQuery
boolean

Whether this field can be referred to in Coveo Cloud query syntax expressions.
Default: true

includeInResults
boolean

Whether the field can be included in the raw property of query results.
Default: true

keepAccentsDisplayValueFacet
boolean

Whether field values with differing accents should be considered distinct facet values.
Note: Applicable to field type STRING only.
Default: false

keyValue
boolean

Whether the field is a dictionary field, which contains mappings of keys to values instead of a single value.
Default: false

label
string

A displayable label for the field when used by the facet generator.

mergeWithLexicon
boolean

Whether the field is free text searchable.
Note: Applicable to field type STRING only.
Default: false

multiValueFacet
boolean

Whether the field contains multiple values (see also the multiValueFacetTokenizers property).
Note: Applicable to field type STRING only.
Default: false

multiValueFacetTokenizers
string

The character to use as a value separator, if the field contains multiple values (see also the multiValueFacet property).
Example: ;

name
string

The name of the field, also referred to as the field identifier, or fieldId.
Note: Must match ^([a-z][a-z0-9_]{0,254})$
Example: Date

ranking
boolean

Whether to use the field in result ranking calculation only.
Notes:
- Has a significant impact on query performance.
- Applicable to field type STRING

Default: false

smartDateFacet
boolean

Whether to transform date and time string values into semicolon separated number of days/weeks/months/quarters/years since January 1st, 1900.
Note: Applicable to field type DATE only.
Default: false

sort
boolean

Whether query results can be sorted based on the value of the field.
Default:
- false for STRING type fields.
- true for all other types of fields.

stemming
boolean

Whether to allow an item to match the query when the value of this field for this item stems from the same root as one of the query expression keywords.
Notes:
- applicable to STRING type fields only.
- Has a significant impact on query performance.

Default: false

system
boolean

Whether the field is a standard Coveo field.
Note: system option can not be set to true.
Default: false

type
string
Enum: "LONG" "LONG_64" "DOUBLE" "DATE" "STRING" … 1 more

The data type of the field.
See Field Types.
Allowed values:
- DATE
- LONG
- LONG64
- DOUBLE
- STRING

useCacheForComputedFacet
boolean

Whether to keep computed field data in memory.
Note: Cannot be enabled on STRING type fields.
Default: false

useCacheForNestedQuery
boolean

Whether to keep the data required to perform nested queries in memory.
Note: only applicable to fields which are faceted or multi-value faceted.
Default: false

useCacheForNumericQuery
boolean

Whether to keep the data required to execute operations on numeric and date fields in memory.
Note: Cannot be enabled on STRING type fields.
Default: false

useCacheForSort
boolean

Whether to keep the entire field in memory for fast sorting.
Default: false

Responses

Request samples

Content type
application/json
{
  • "automaticFacetsCandidate": true,
  • "dateFormat": "string",
  • "description": "string",
  • "facet": true,
  • "hierarchicalFacet": true,
  • "includeInQuery": true,
  • "includeInResults": true,
  • "keepAccentsDisplayValueFacet": true,
  • "keyValue": true,
  • "label": "string",
  • "mergeWithLexicon": true,
  • "multiValueFacet": true,
  • "multiValueFacetTokenizers": "string",
  • "name": "string",
  • "ranking": true,
  • "smartDateFacet": true,
  • "sort": true,
  • "stemming": true,
  • "system": true,
  • "type": "LONG",
  • "useCacheForComputedFacet": true,
  • "useCacheForNestedQuery": true,
  • "useCacheForNumericQuery": true,
  • "useCacheForSort": true
}

Create fields

Creates a batch of fields in the index of the target Coveo Cloud organization.

Required privilege: Fields - Create

Privilege required

{"owner":"PLATFORM","targetDomain":"FIELD","type":"CREATE","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
Array
automaticFacetsCandidate
boolean

Whether this field is to be considered by the facet generator feature.
Default: true if a facet or multivalue facet field.

dateFormat
string

A regex indicating the date format, for some date type fields.
Example: %Y/%m/%d@%H:%M:%S%G

description
string

A description of the field.
Example: The date of creation of a given item

facet
boolean

Whether Group By operations and Facet requests can be performed on the field.
Default:
- false for STRING type fields.
- true for all other types of fields.

hierarchicalFacet
boolean

Whether the field contains multiple values that form a hierarchy (see also the multiValueFacetTokenizers property).
Note: Applicable to field type STRING only.
Default: false

includeInQuery
boolean

Whether this field can be referred to in Coveo Cloud query syntax expressions.
Default: true

includeInResults
boolean

Whether the field can be included in the raw property of query results.
Default: true

keepAccentsDisplayValueFacet
boolean

Whether field values with differing accents should be considered distinct facet values.
Note: Applicable to field type STRING only.
Default: false

keyValue
boolean

Whether the field is a dictionary field, which contains mappings of keys to values instead of a single value.
Default: false

label
string

A displayable label for the field when used by the facet generator.

mergeWithLexicon
boolean

Whether the field is free text searchable.
Note: Applicable to field type STRING only.
Default: false

multiValueFacet
boolean

Whether the field contains multiple values (see also the multiValueFacetTokenizers property).
Note: Applicable to field type STRING only.
Default: false

multiValueFacetTokenizers
string

The character to use as a value separator, if the field contains multiple values (see also the multiValueFacet property).
Example: ;

name
string

The name of the field, also referred to as the field identifier, or fieldId.
Note: Must match ^([a-z][a-z0-9_]{0,254})$
Example: Date

ranking
boolean

Whether to use the field in result ranking calculation only.
Notes:
- Has a significant impact on query performance.
- Applicable to field type STRING

Default: false

smartDateFacet
boolean

Whether to transform date and time string values into semicolon separated number of days/weeks/months/quarters/years since January 1st, 1900.
Note: Applicable to field type DATE only.
Default: false

sort
boolean

Whether query results can be sorted based on the value of the field.
Default:
- false for STRING type fields.
- true for all other types of fields.

stemming
boolean

Whether to allow an item to match the query when the value of this field for this item stems from the same root as one of the query expression keywords.
Notes:
- applicable to STRING type fields only.
- Has a significant impact on query performance.

Default: false

system
boolean

Whether the field is a standard Coveo field.
Note: system option can not be set to true.
Default: false

type
string
Enum: "LONG" "LONG_64" "DOUBLE" "DATE" "STRING" … 1 more

The data type of the field.
See Field Types.
Allowed values:
- DATE
- LONG
- LONG64
- DOUBLE
- STRING

useCacheForComputedFacet
boolean

Whether to keep computed field data in memory.
Note: Cannot be enabled on STRING type fields.
Default: false

useCacheForNestedQuery
boolean

Whether to keep the data required to perform nested queries in memory.
Note: only applicable to fields which are faceted or multi-value faceted.
Default: false

useCacheForNumericQuery
boolean

Whether to keep the data required to execute operations on numeric and date fields in memory.
Note: Cannot be enabled on STRING type fields.
Default: false

useCacheForSort
boolean

Whether to keep the entire field in memory for fast sorting.
Default: false

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Create fields with individual results

Creates a batch of fields in the index of the target Coveo Cloud organization.

Required privilege: Fields - Create

Privilege required

{"owner":"PLATFORM","targetDomain":"FIELD","type":"CREATE","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
Array
automaticFacetsCandidate
boolean

Whether this field is to be considered by the facet generator feature.
Default: true if a facet or multivalue facet field.

dateFormat
string

A regex indicating the date format, for some date type fields.
Example: %Y/%m/%d@%H:%M:%S%G

description
string

A description of the field.
Example: The date of creation of a given item

facet
boolean

Whether Group By operations and Facet requests can be performed on the field.
Default:
- false for STRING type fields.
- true for all other types of fields.

hierarchicalFacet
boolean

Whether the field contains multiple values that form a hierarchy (see also the multiValueFacetTokenizers property).
Note: Applicable to field type STRING only.
Default: false

includeInQuery
boolean

Whether this field can be referred to in Coveo Cloud query syntax expressions.
Default: true

includeInResults
boolean

Whether the field can be included in the raw property of query results.
Default: true

keepAccentsDisplayValueFacet
boolean

Whether field values with differing accents should be considered distinct facet values.
Note: Applicable to field type STRING only.
Default: false

keyValue
boolean

Whether the field is a dictionary field, which contains mappings of keys to values instead of a single value.
Default: false

label
string

A displayable label for the field when used by the facet generator.

mergeWithLexicon
boolean

Whether the field is free text searchable.
Note: Applicable to field type STRING only.
Default: false

multiValueFacet
boolean

Whether the field contains multiple values (see also the multiValueFacetTokenizers property).
Note: Applicable to field type STRING only.
Default: false

multiValueFacetTokenizers
string

The character to use as a value separator, if the field contains multiple values (see also the multiValueFacet property).
Example: ;

name
string

The name of the field, also referred to as the field identifier, or fieldId.
Note: Must match ^([a-z][a-z0-9_]{0,254})$
Example: Date

ranking
boolean

Whether to use the field in result ranking calculation only.
Notes:
- Has a significant impact on query performance.
- Applicable to field type STRING

Default: false

smartDateFacet
boolean

Whether to transform date and time string values into semicolon separated number of days/weeks/months/quarters/years since January 1st, 1900.
Note: Applicable to field type DATE only.
Default: false

sort
boolean

Whether query results can be sorted based on the value of the field.
Default:
- false for STRING type fields.
- true for all other types of fields.

stemming
boolean

Whether to allow an item to match the query when the value of this field for this item stems from the same root as one of the query expression keywords.
Notes:
- applicable to STRING type fields only.
- Has a significant impact on query performance.

Default: false

system
boolean

Whether the field is a standard Coveo field.
Note: system option can not be set to true.
Default: false

type
string
Enum: "LONG" "LONG_64" "DOUBLE" "DATE" "STRING" … 1 more

The data type of the field.
See Field Types.
Allowed values:
- DATE
- LONG
- LONG64
- DOUBLE
- STRING

useCacheForComputedFacet
boolean

Whether to keep computed field data in memory.
Note: Cannot be enabled on STRING type fields.
Default: false

useCacheForNestedQuery
boolean

Whether to keep the data required to perform nested queries in memory.
Note: only applicable to fields which are faceted or multi-value faceted.
Default: false

useCacheForNumericQuery
boolean

Whether to keep the data required to execute operations on numeric and date fields in memory.
Note: Cannot be enabled on STRING type fields.
Default: false

useCacheForSort
boolean

Whether to keep the entire field in memory for fast sorting.
Default: false

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Delete fields

Deletes a batch of fields in the index of the target Coveo Cloud organization.

Required privilege: Fields - Edit

Privilege required

{"owner":"PLATFORM","targetDomain":"FIELD","type":"EDIT","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

query Parameters
fields
required
Array of strings

The name properties of the fields to delete.
Example: myfield1,myfield2,myfield3

Responses

Delete fields with individual results

Deletes a batch of fields in the index of the target Coveo Cloud organization.

Required privilege: Fields - Edit

Privilege required

{"owner":"PLATFORM","targetDomain":"FIELD","type":"EDIT","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

query Parameters
fields
required
Array of strings

The name properties of the fields to delete.
Example: myfield1,myfield2,myfield3

Responses

Update fields

Updates a batch of existing fields in the index of the target Coveo Cloud organization.

Required privilege: Fields - Edit

Privilege required

{"owner":"PLATFORM","targetDomain":"FIELD","type":"EDIT","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
Array
automaticFacetsCandidate
boolean

Whether this field is to be considered by the facet generator feature.
Default: true if a facet or multivalue facet field.

dateFormat
string

A regex indicating the date format, for some date type fields.
Example: %Y/%m/%d@%H:%M:%S%G

description
string

A description of the field.
Example: The date of creation of a given item

facet
boolean

Whether Group By operations and Facet requests can be performed on the field.
Default:
- false for STRING type fields.
- true for all other types of fields.

hierarchicalFacet
boolean

Whether the field contains multiple values that form a hierarchy (see also the multiValueFacetTokenizers property).
Note: Applicable to field type STRING only.
Default: false

includeInQuery
boolean

Whether this field can be referred to in Coveo Cloud query syntax expressions.
Default: true

includeInResults
boolean

Whether the field can be included in the raw property of query results.
Default: true

keepAccentsDisplayValueFacet
boolean

Whether field values with differing accents should be considered distinct facet values.
Note: Applicable to field type STRING only.
Default: false

keyValue
boolean

Whether the field is a dictionary field, which contains mappings of keys to values instead of a single value.
Default: false

label
string

A displayable label for the field when used by the facet generator.

mergeWithLexicon
boolean

Whether the field is free text searchable.
Note: Applicable to field type STRING only.
Default: false

multiValueFacet
boolean

Whether the field contains multiple values (see also the multiValueFacetTokenizers property).
Note: Applicable to field type STRING only.
Default: false

multiValueFacetTokenizers
string

The character to use as a value separator, if the field contains multiple values (see also the multiValueFacet property).
Example: ;

name
string

The name of the field, also referred to as the field identifier, or fieldId.
Note: Must match ^([a-z][a-z0-9_]{0,254})$
Example: Date

ranking
boolean

Whether to use the field in result ranking calculation only.
Notes:
- Has a significant impact on query performance.
- Applicable to field type STRING

Default: false

smartDateFacet
boolean

Whether to transform date and time string values into semicolon separated number of days/weeks/months/quarters/years since January 1st, 1900.
Note: Applicable to field type DATE only.
Default: false

sort
boolean

Whether query results can be sorted based on the value of the field.
Default:
- false for STRING type fields.
- true for all other types of fields.

stemming
boolean

Whether to allow an item to match the query when the value of this field for this item stems from the same root as one of the query expression keywords.
Notes:
- applicable to STRING type fields only.
- Has a significant impact on query performance.

Default: false

system
boolean

Whether the field is a standard Coveo field.
Note: system option can not be set to true.
Default: false

type
string
Enum: "LONG" "LONG_64" "DOUBLE" "DATE" "STRING" … 1 more

The data type of the field.
See Field Types.
Allowed values:
- DATE
- LONG
- LONG64
- DOUBLE
- STRING

useCacheForComputedFacet
boolean

Whether to keep computed field data in memory.
Note: Cannot be enabled on STRING type fields.
Default: false

useCacheForNestedQuery
boolean

Whether to keep the data required to perform nested queries in memory.
Note: only applicable to fields which are faceted or multi-value faceted.
Default: false

useCacheForNumericQuery
boolean

Whether to keep the data required to execute operations on numeric and date fields in memory.
Note: Cannot be enabled on STRING type fields.
Default: false

useCacheForSort
boolean

Whether to keep the entire field in memory for fast sorting.
Default: false

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Update fields with individual results

Updates a batch of existing fields in the index of the target Coveo Cloud organization.

Required privilege: Fields - Edit

Privilege required

{"owner":"PLATFORM","targetDomain":"FIELD","type":"EDIT","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
Array
automaticFacetsCandidate
boolean

Whether this field is to be considered by the facet generator feature.
Default: true if a facet or multivalue facet field.

dateFormat
string

A regex indicating the date format, for some date type fields.
Example: %Y/%m/%d@%H:%M:%S%G

description
string

A description of the field.
Example: The date of creation of a given item

facet
boolean

Whether Group By operations and Facet requests can be performed on the field.
Default:
- false for STRING type fields.
- true for all other types of fields.

hierarchicalFacet
boolean

Whether the field contains multiple values that form a hierarchy (see also the multiValueFacetTokenizers property).
Note: Applicable to field type STRING only.
Default: false

includeInQuery
boolean

Whether this field can be referred to in Coveo Cloud query syntax expressions.
Default: true

includeInResults
boolean

Whether the field can be included in the raw property of query results.
Default: true

keepAccentsDisplayValueFacet
boolean

Whether field values with differing accents should be considered distinct facet values.
Note: Applicable to field type STRING only.
Default: false

keyValue
boolean

Whether the field is a dictionary field, which contains mappings of keys to values instead of a single value.
Default: false

label
string

A displayable label for the field when used by the facet generator.

mergeWithLexicon
boolean

Whether the field is free text searchable.
Note: Applicable to field type STRING only.
Default: false

multiValueFacet
boolean

Whether the field contains multiple values (see also the multiValueFacetTokenizers property).
Note: Applicable to field type STRING only.
Default: false

multiValueFacetTokenizers
string

The character to use as a value separator, if the field contains multiple values (see also the multiValueFacet property).
Example: ;

name
string

The name of the field, also referred to as the field identifier, or fieldId.
Note: Must match ^([a-z][a-z0-9_]{0,254})$
Example: Date

ranking
boolean

Whether to use the field in result ranking calculation only.
Notes:
- Has a significant impact on query performance.
- Applicable to field type STRING

Default: false

smartDateFacet
boolean

Whether to transform date and time string values into semicolon separated number of days/weeks/months/quarters/years since January 1st, 1900.
Note: Applicable to field type DATE only.
Default: false

sort
boolean

Whether query results can be sorted based on the value of the field.
Default:
- false for STRING type fields.
- true for all other types of fields.

stemming
boolean

Whether to allow an item to match the query when the value of this field for this item stems from the same root as one of the query expression keywords.
Notes:
- applicable to STRING type fields only.
- Has a significant impact on query performance.

Default: false

system
boolean

Whether the field is a standard Coveo field.
Note: system option can not be set to true.
Default: false

type
string
Enum: "LONG" "LONG_64" "DOUBLE" "DATE" "STRING" … 1 more

The data type of the field.
See Field Types.
Allowed values:
- DATE
- LONG
- LONG64
- DOUBLE
- STRING

useCacheForComputedFacet
boolean

Whether to keep computed field data in memory.
Note: Cannot be enabled on STRING type fields.
Default: false

useCacheForNestedQuery
boolean

Whether to keep the data required to perform nested queries in memory.
Note: only applicable to fields which are faceted or multi-value faceted.
Default: false

useCacheForNumericQuery
boolean

Whether to keep the data required to execute operations on numeric and date fields in memory.
Note: Cannot be enabled on STRING type fields.
Default: false

useCacheForSort
boolean

Whether to keep the entire field in memory for fast sorting.
Default: false

Responses

Request samples

Content type
application/json
[
  • {
    }
]

List fields

Retrieves a filtered and paginated list of fields from the index of the target Coveo Cloud organization.

Required privilege: Fields - View

Privilege required

{"owner":"PLATFORM","targetDomain":"FIELD","type":"VIEW","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Request Body schema: application/json
required
object (FieldListingFilters)

Filters to narrow down the returned fields.

order
string

The sort direction of the results.
Allowed values:
- ASC: Ascending order.
- DESC: Descending order.

Default: ASC

page
integer <int32>

The 0-based number of the page of results to list.
Minimum: 0
Default: 0

perPage
integer <int32>

The maximum number of results to include per page.
Must be in range: [1, 1000]
Default: 100

sortBy
string

The field property by which to sort results.
Default: name

Responses

Request samples

Content type
application/json
{
  • "filters": {
    },
  • "order": "string",
  • "page": 0,
  • "perPage": 0,
  • "sortBy": "string"
}

Delete field

Deletes a field in the index of the target Coveo Cloud organization.

Required privilege: Fields - Edit

Privilege required

{"owner":"PLATFORM","targetDomain":"FIELD","type":"EDIT","targetId":"*"}
Authorizations:
oauth2
path Parameters
fieldId
required
string

The name property of the field to delete.
Example: numberoflikes

organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Responses

Show field

Shows information regarding a single field in the index of the target Coveo Cloud organization.

Required privilege: Fields - View

Privilege required

{"owner":"PLATFORM","targetDomain":"FIELD","type":"VIEW","targetId":"*"}
Authorizations:
oauth2
path Parameters
fieldId
required
string

The name property of the field to retrieve.
Example: numberoflikes

organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Responses

Update field

Updates an existing field in the index of the target Coveo Cloud organization.

Required privilege: Fields - Edit

Privilege required

{"owner":"PLATFORM","targetDomain":"FIELD","type":"EDIT","targetId":"*"}
Authorizations:
oauth2
path Parameters
fieldId
required
string

The name property of the field to update.
Example: numberoflikes

organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Request Body schema: application/json
required
automaticFacetsCandidate
boolean

Whether this field is to be considered by the facet generator feature.
Default: true if a facet or multivalue facet field.

dateFormat
string

A regex indicating the date format, for some date type fields.
Example: %Y/%m/%d@%H:%M:%S%G

description
string

A description of the field.
Example: The date of creation of a given item

facet
boolean

Whether Group By operations and Facet requests can be performed on the field.
Default:
- false for STRING type fields.
- true for all other types of fields.

hierarchicalFacet
boolean

Whether the field contains multiple values that form a hierarchy (see also the multiValueFacetTokenizers property).
Note: Applicable to field type STRING only.
Default: false

includeInQuery
boolean

Whether this field can be referred to in Coveo Cloud query syntax expressions.
Default: true

includeInResults
boolean

Whether the field can be included in the raw property of query results.
Default: true

keepAccentsDisplayValueFacet
boolean

Whether field values with differing accents should be considered distinct facet values.
Note: Applicable to field type STRING only.
Default: false

keyValue
boolean

Whether the field is a dictionary field, which contains mappings of keys to values instead of a single value.
Default: false

label
string

A displayable label for the field when used by the facet generator.

mergeWithLexicon
boolean

Whether the field is free text searchable.
Note: Applicable to field type STRING only.
Default: false

multiValueFacet
boolean

Whether the field contains multiple values (see also the multiValueFacetTokenizers property).
Note: Applicable to field type STRING only.
Default: false

multiValueFacetTokenizers
string

The character to use as a value separator, if the field contains multiple values (see also the multiValueFacet property).
Example: ;

name
string

The name of the field, also referred to as the field identifier, or fieldId.
Note: Must match ^([a-z][a-z0-9_]{0,254})$
Example: Date

ranking
boolean

Whether to use the field in result ranking calculation only.
Notes:
- Has a significant impact on query performance.
- Applicable to field type STRING

Default: false

smartDateFacet
boolean

Whether to transform date and time string values into semicolon separated number of days/weeks/months/quarters/years since January 1st, 1900.
Note: Applicable to field type DATE only.
Default: false

sort
boolean

Whether query results can be sorted based on the value of the field.
Default:
- false for STRING type fields.
- true for all other types of fields.

stemming
boolean

Whether to allow an item to match the query when the value of this field for this item stems from the same root as one of the query expression keywords.
Notes:
- applicable to STRING type fields only.
- Has a significant impact on query performance.

Default: false

system
boolean

Whether the field is a standard Coveo field.
Note: system option can not be set to true.
Default: false

type
string
Enum: "LONG" "LONG_64" "DOUBLE" "DATE" "STRING" … 1 more

The data type of the field.
See Field Types.
Allowed values:
- DATE
- LONG
- LONG64
- DOUBLE
- STRING

useCacheForComputedFacet
boolean

Whether to keep computed field data in memory.
Note: Cannot be enabled on STRING type fields.
Default: false

useCacheForNestedQuery
boolean

Whether to keep the data required to perform nested queries in memory.
Note: only applicable to fields which are faceted or multi-value faceted.
Default: false

useCacheForNumericQuery
boolean

Whether to keep the data required to execute operations on numeric and date fields in memory.
Note: Cannot be enabled on STRING type fields.
Default: false

useCacheForSort
boolean

Whether to keep the entire field in memory for fast sorting.
Default: false

Responses

Request samples

Content type
application/json
{
  • "automaticFacetsCandidate": true,
  • "dateFormat": "string",
  • "description": "string",
  • "facet": true,
  • "hierarchicalFacet": true,
  • "includeInQuery": true,
  • "includeInResults": true,
  • "keepAccentsDisplayValueFacet": true,
  • "keyValue": true,
  • "label": "string",
  • "mergeWithLexicon": true,
  • "multiValueFacet": true,
  • "multiValueFacetTokenizers": "string",
  • "name": "string",
  • "ranking": true,
  • "smartDateFacet": true,
  • "sort": true,
  • "stemming": true,
  • "system": true,
  • "type": "LONG",
  • "useCacheForComputedFacet": true,
  • "useCacheForNestedQuery": true,
  • "useCacheForNumericQuery": true,
  • "useCacheForSort": true
}