openapi: 3.0.1
info:
title: Coveo Catalog Management API
description: API for Coveo Platform
termsOfService: https://www.coveo.com/en/support/terms-agreements
contact:
name: Coveo
url: https://connect.coveo.com/s/discussions
version: 1.0.0
servers:
- url: https://platform.cloud.coveo.com
description: Coveo public API endpoint
security:
- oauth2:
- full
paths:
/rest/organizations/{organizationId}/catalogs/{catalogId}:
get:
tags:
- Catalogs
summary: Show Catalog
description: 'Shows a [catalog](https://docs.coveo.com/en/3143/) in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required
privilege:** Catalogs - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"CATALOG","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getCatalog
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: catalogId
in: path
description: The unique identifier of the [catalog](https://docs.coveo.com/en/3143/) to show.<br />**Example:** `644e1dd7-2a7f-18fb-b8ed-ed78c3f92c2b`
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/CatalogModel'
x-pretty-name: getCatalog
x-required-privilege:
owner: COMMERCE
targetDomain: CATALOG
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: CATALOG
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/catalogs/paramId_get
put:
tags:
- Catalogs
summary: Update Catalog
description: 'Updates a [catalog](https://docs.coveo.com/en/3143/) in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required
privilege:** Catalogs - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"CATALOG","type":"EDIT","targetId":"*"}
```
</details>'
operationId: updateCatalog
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: catalogId
in: path
description: The unique identifier of the [catalog](https://docs.coveo.com/en/3143/) to update.<br />**Example:**
`644e1dd7-2a7f-18fb-b8ed-ed78c3f92c2b`
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCatalogModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateCatalogModel'
x-pretty-name: updateCatalog
x-required-privilege:
owner: COMMERCE
targetDomain: CATALOG
type: EDIT
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: CATALOG
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/catalogs/paramId_put
delete:
tags:
- Catalogs
summary: Delete Catalog
description: 'Deletes a [catalog](https://docs.coveo.com/en/3143/) in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required
privilege:** Catalogs - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"CATALOG","type":"EDIT","targetId":"*"}
```
</details>'
operationId: deleteCatalog
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: catalogId
in: path
description: The unique identifier of the [catalog](https://docs.coveo.com/en/3143/) to delete.<br />**Example:**
`644e1dd7-2a7f-18fb-b8ed-ed78c3f92c2b`
required: true
schema:
type: string
format: uuid
responses:
'204':
description: No Content - Catalog successfully deleted
'400':
description: Bad Request - The catalog is associated with a tracking ID to catalog mapping
'404':
description: Not Found - The catalog does not exist
x-pretty-name: deleteCatalog
x-required-privilege:
owner: COMMERCE
targetDomain: CATALOG
type: EDIT
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: CATALOG
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/catalogs/paramId_delete
/rest/organizations/{organizationId}/catalogconfigurations/{configurationId}:
get:
tags:
- Catalog Configurations
summary: Show Catalog Configuration
description: 'Shows a catalog configuration in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required
privilege:** Catalogs - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"CATALOG","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getCatalogConfiguration
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: configurationId
in: path
description: The unique identifier of the catalog configuration to show.<br />**Example:** `644e1dd7-2a7f-18fb-b8ed-ed78c3f92c2b`
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/CatalogConfigurationModelWithAssociatedCatalogs'
x-pretty-name: getCatalogConfiguration
x-required-privilege:
owner: COMMERCE
targetDomain: CATALOG
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: CATALOG
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/catalogconfigurations/paramId_get
put:
tags:
- Catalog Configurations
summary: Update Catalog Configuration
description: 'Updates a catalog configuration in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required
privilege:** Catalogs - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"CATALOG","type":"EDIT","targetId":"*"}
```
</details>'
operationId: updateCatalogConfiguration
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: configurationId
in: path
description: The unique identifier of the catalog configuration to update.<br />**Example:** `644e1dd7-2a7f-18fb-b8ed-ed78c3f92c2b`
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCatalogConfigurationModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/CatalogConfigurationModelWithAssociatedCatalogs'
x-pretty-name: updateCatalogConfiguration
x-required-privilege:
owner: COMMERCE
targetDomain: CATALOG
type: EDIT
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: CATALOG
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/catalogconfigurations/paramId_put
delete:
tags:
- Catalog Configurations
summary: Delete Catalog Configuration
description: 'Deletes a catalog configuration in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required
privilege:** Catalogs - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"CATALOG","type":"EDIT","targetId":"*"}
```
</details>'
operationId: deleteCatalogConfiguration
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: configurationId
in: path
description: The unique identifier of the catalog configuration to delete.<br />**Example:** `644e1dd7-2a7f-18fb-b8ed-ed78c3f92c2b`
required: true
schema:
type: string
format: uuid
responses:
'204':
description: No Content
x-pretty-name: deleteCatalogConfiguration
x-required-privilege:
owner: COMMERCE
targetDomain: CATALOG
type: EDIT
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: CATALOG
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/catalogconfigurations/paramId_delete
/api/preview/organizations/{organizationId}/catalog-management/catalogs/{catalogId}/view-definitions:
get:
tags:
- View Definitions
summary: Get View Definitions for a Catalog
description: 'Retrieves the view definitions for a specific catalog. </br></br>**Required privilege:** Catalogs - View<br
/><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"CATALOG","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getViewDefinitions
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: catalogId
in: path
description: The unique identifier of the [catalog](https://docs.coveo.com/en/3143/).
required: true
schema:
type: string
format: uuid
responses:
'200':
description: View definitions retrieved successfully
content:
'*/*':
schema:
$ref: '#/components/schemas/ViewDefinitionsModel'
'404':
description: Organization or catalog not found
content:
'*/*':
schema:
$ref: '#/components/schemas/ViewDefinitionsModel'
x-pretty-name: getViewDefinitions
x-required-privilege:
owner: COMMERCE
targetDomain: CATALOG
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: CATALOG
type: VIEW
targetId: '*'
x-ui-operation-id: /api/preview/organizations/paramId/catalog-management/catalogs/paramId/view-definitions_get
put:
tags:
- View Definitions
summary: Update View Definitions for a Catalog
description: 'Updates the view definitions for a specific catalog. This replaces all existing view definitions.</br></br>**Required
privilege:** Catalogs - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"CATALOG","type":"EDIT","targetId":"*"}
```
</details>'
operationId: putViewDefinitions
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: catalogId
in: path
description: The unique identifier of the [catalog](https://docs.coveo.com/en/3143/).
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ViewDefinitionsModel'
required: true
responses:
'200':
description: View definitions updated successfully
content:
'*/*':
schema:
$ref: '#/components/schemas/ViewDefinitionsModel'
'404':
description: Organization or catalog not found
content:
'*/*':
schema:
$ref: '#/components/schemas/ViewDefinitionsModel'
x-pretty-name: putViewDefinitions
x-required-privilege:
owner: COMMERCE
targetDomain: CATALOG
type: EDIT
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: CATALOG
type: EDIT
targetId: '*'
x-ui-operation-id: /api/preview/organizations/paramId/catalog-management/catalogs/paramId/view-definitions_put
/api/preview/organizations/{organizationId}/catalog-management/catalogs/{catalogId}/filter:
get:
tags:
- Catalog Filter
summary: Get Filter for a Catalog
description: 'Retrieves the filter for a specific catalog.</br></br>**Required privilege:** Catalogs - View<br /><br
/><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"CATALOG","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getCatalogFilter
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: catalogId
in: path
description: The unique identifier of the [catalog](https://docs.coveo.com/en/3143/).
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Catalog filter retrieved successfully
content:
'*/*':
schema:
$ref: '#/components/schemas/CatalogFilterModel'
'404':
description: Organization or catalog not found
content:
'*/*':
schema:
$ref: '#/components/schemas/CatalogFilterModel'
'412':
description: Catalog filters feature is unavailable
content:
'*/*':
schema:
$ref: '#/components/schemas/CatalogFilterModel'
x-pretty-name: getCatalogFilter
x-required-privilege:
owner: COMMERCE
targetDomain: CATALOG
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: CATALOG
type: VIEW
targetId: '*'
x-ui-operation-id: /api/preview/organizations/paramId/catalog-management/catalogs/paramId/filter_get
put:
tags:
- Catalog Filter
summary: Create or Update the Filter for a Catalog
description: 'Creates or updates the filter for a specific catalog.</br></br>**Required privilege:** Catalogs - Edit<br
/><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"CATALOG","type":"EDIT","targetId":"*"}
```
</details>'
operationId: putCatalogFilter
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: catalogId
in: path
description: The unique identifier of the [catalog](https://docs.coveo.com/en/3143/).
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogFilterModel'
required: true
responses:
'200':
description: Catalog filter updated successfully
content:
'*/*':
schema:
$ref: '#/components/schemas/CatalogFilterModel'
'404':
description: Organization or catalog not found
content:
'*/*':
schema:
$ref: '#/components/schemas/CatalogFilterModel'
'412':
description: Precondition failed. Check the error message.
content:
'*/*':
schema:
$ref: '#/components/schemas/CatalogFilterModel'
x-pretty-name: putCatalogFilter
x-required-privilege:
owner: COMMERCE
targetDomain: CATALOG
type: EDIT
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: CATALOG
type: EDIT
targetId: '*'
x-ui-operation-id: /api/preview/organizations/paramId/catalog-management/catalogs/paramId/filter_put
/rest/organizations/{organizationId}/catalogs:
get:
tags:
- Catalogs
summary: List Catalogs
description: 'Lists the [catalogs](https://docs.coveo.com/en/3143/) of an [organization](https://docs.coveo.com/en/185/).</br></br>**Required
privilege:** Catalogs - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"CATALOG","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getCatalogs
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: filter
in: query
description: Filter that will be matched against the catalog id, name, description and its configuration name..<br
/>**Example:** `catalogName`
required: false
schema:
type: string
- name: catalogIds
in: query
description: List of the unique identifiers of the [catalog](https://docs.coveo.com/en/3143/) to show.<br />**Example:**
`[644e1dd7-2a7f-18fb-b8ed-ed78c3f92c2b]`
required: false
schema:
type: array
items:
type: string
format: uuid
- name: sourceIds
in: query
description: List of the unique identifiers of the sources
required: false
schema:
type: array
items:
type: string
- name: page
in: query
description: The 0-based index number of the page of catalogs to retrieve.</br>**Minimum:** `0`</br>**Default:** `0`
required: false
schema:
minimum: 0
type: integer
format: int32
default: 0
- name: pageSize
in: query
description: The number of catalogs to list per page.</br>**Minimum:** `1`</br>**Maximum:** `1000`</br>**Default:**
`10`
required: false
schema:
maximum: 1000
minimum: 1
type: integer
format: int32
default: 10
- name: enrichWithFields
in: query
description: If true, catalog will be enriched with field suggestions. This requires a call to SearchAPI
required: false
schema:
type: boolean
default: true
- name: catalogSortingType
in: query
description: The field to sort the returned catalogs by.</br>**Default:** `name`
required: false
schema:
type: string
default: NAME
enum:
- NAME
- name: sortingDirection
in: query
description: The `sortingType` order to list the catalogs in.</br>**Default:** `ASC`
required: false
schema:
type: string
default: ASC
enum:
- ASC
- DESC
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/CommercePageModelCatalogModel'
x-pretty-name: getCatalogs
x-required-privilege:
owner: COMMERCE
targetDomain: CATALOG
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: CATALOG
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/catalogs_get
post:
tags:
- Catalogs
summary: Create Catalog
description: 'Creates a [catalog](https://docs.coveo.com/en/3143/) in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required
privilege:** Catalogs - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"CATALOG","type":"EDIT","targetId":"*"}
```
</details>'
operationId: createCatalog
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCatalogV1Model'
required: true
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateCatalogModel'
x-pretty-name: createCatalog
x-required-privilege:
owner: COMMERCE
targetDomain: CATALOG
type: EDIT
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: CATALOG
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/catalogs_post
/rest/organizations/{organizationId}/catalogs/ids:
post:
tags:
- Catalogs
summary: List Catalogs Using Catalog Ids as a Body for Filtering.
description: 'Lists the [catalogs](https://docs.coveo.com/en/3143/) of an [organization](https://docs.coveo.com/en/185/).</br></br>**Required
privilege:** Catalogs - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"CATALOG","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getCatalogsWithIdsBody
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: filter
in: query
description: Filter that will be matched against the catalog id, name, description and its configuration name..<br
/>**Example:** `catalogName`
required: false
schema:
type: string
- name: sourceIds
in: query
description: List of the unique identifiers of the sources
required: false
schema:
type: array
items:
type: string
- name: page
in: query
description: The 0-based index number of the page of catalogs to retrieve.</br>**Minimum:** `0`</br>**Default:** `0`
required: false
schema:
minimum: 0
type: integer
format: int32
default: 0
- name: pageSize
in: query
description: The number of catalogs to list per page.</br>**Minimum:** `1`</br>**Maximum:** `1000`</br>**Default:**
`10`
required: false
schema:
maximum: 1000
minimum: 1
type: integer
format: int32
default: 10
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
format: uuid
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/CommercePageModelCatalogModel'
x-pretty-name: getCatalogsWithIdsBody
x-required-privilege:
owner: COMMERCE
targetDomain: CATALOG
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: CATALOG
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/catalogs/ids_post
/rest/organizations/{organizationId}/catalogs/fieldsSuggestions:
post:
tags:
- Catalogs
summary: Suggest Fields
description: 'Shows suggested fields and sample values for mapping in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required
privilege:** Execute Query<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"SEARCH_API","targetDomain":"EXECUTE_QUERY","targetId":"*"}
```
</details>'
operationId: getFieldsSuggestions
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FieldsSuggestionsQueryModel'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/FieldsSuggestionsModel'
x-pretty-name: getFieldsSuggestions
x-required-privilege:
owner: SEARCH_API
targetDomain: EXECUTE_QUERY
targetId: '*'
x-required-privileges:
- owner: SEARCH_API
targetDomain: EXECUTE_QUERY
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/catalogs/fieldsSuggestions_post
/rest/organizations/{organizationId}/catalogconfigurations:
get:
tags:
- Catalog Configurations
summary: List Catalog Configurations
description: 'Lists the catalog configuration of an [organization](https://docs.coveo.com/en/185/).</br></br>**Required
privilege:** Catalogs - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"CATALOG","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getCatalogConfigurations
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: page
in: query
description: The 0-based index number of the page of catalog configurations to retrieve.</br>**Minimum:** `0`</br>**Default:**
`0`
required: false
schema:
minimum: 0
type: integer
format: int32
default: 0
- name: pageSize
in: query
description: The number of catalog configurations to list per page.</br>**Minimum:** `1`</br>**Maximum:** `1000`</br>**Default:**
`10`
required: false
schema:
maximum: 1000
minimum: 1
type: integer
format: int32
default: 10
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/CommercePageModelCatalogConfigurationModelWithAssociatedCatalogs'
x-pretty-name: getCatalogConfigurations
x-required-privilege:
owner: COMMERCE
targetDomain: CATALOG
type: VIEW
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: CATALOG
type: VIEW
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/catalogconfigurations_get
post:
tags:
- Catalog Configurations
summary: Create Configuration
description: 'Creates a catalog configuration in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required
privilege:** Catalogs - Edit<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"CATALOG","type":"EDIT","targetId":"*"}
```
</details>'
operationId: createCatalogConfiguration
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCatalogConfigurationV1Model'
required: true
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateCatalogConfigurationModel'
x-pretty-name: createCatalogConfiguration
x-required-privilege:
owner: COMMERCE
targetDomain: CATALOG
type: EDIT
targetId: '*'
x-required-privileges:
- owner: COMMERCE
targetDomain: CATALOG
type: EDIT
targetId: '*'
x-ui-operation-id: /rest/organizations/paramId/catalogconfigurations_post
/rest/organizations/{organizationId}/catalogs/{catalogId}/fieldStats:
get:
tags:
- Catalogs
summary: Show Field Stats
description: 'Retrieve statistics about the usage of fields by objects in the catalog''s source.</br></br>**Required
privilege:** Catalogs - View<br /><br /><details><summary>Privilege required</summary>
```
{"owner":"COMMERCE","targetDomain":"CATALOG","type":"VIEW","targetId":"*"}
```
</details>'
operationId: getFieldStats
parameters:
- name: organizationId
in: path
description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
`acmecorporation8tp8wu3`
required: true
schema:
type: string
- name: catalogId
in: path
description: The unique identifier of the [catalog](https://docs.coveo.com/en/3143/).
required: true
schema:
type: string
format: uuid
- name: forceRefresh
in: query
description: If true, the database cache will be refreshed and the most up-to-date fields data returned.
required: false
schema:
# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-catalog-management-openapi-original.yml