openapi: 3.0.1 info: title: Usage Analytics Read API version: '1.0' servers: - url: https://analytics.cloud.coveo.com/rest/ua description: Coveo public API endpoint security: - v8: - full tags: - name: Dimensions API - Version 14 - name: Exports API - Version 14 - name: Filters API - Version 14 - name: Metrics API - Version 14 - name: Reports API - Version 14 - name: Statistics API - Version 14 - name: Users API - Version 14 - name: Administration API - Version 15 - name: Data Health API - Version 15 - name: Dimensions API - Version 15 - name: Exports API - Version 15 - name: Filters API - Version 15 - name: Groups API - Version 15 - name: Metrics API - Version 15 - name: Reader Account API - Version 15 - name: Reports API - Version 15 - name: Secure Data Sharing API - Version 15 - name: Statistics API - Version 15 - name: Users API - Version 15 - name: User Statistics API - Version 15 paths: /v14/dimensions/custom: get: tags: - Dimensions API - Version 14 summary: Get All the Custom Dimensions description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_dimensions_custom parameters: - name: includeOnlyParents in: query description: This will filter out dimensions which are covered by others. Only parent/master dimensions will be output schema: type: boolean default: false - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/DimensionResponseV14' deprecated: true post: tags: - Dimensions API - Version 14 summary: Create a Custom Dimension description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: post__v14_dimensions_custom parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: name in: query description: The name of the custom dimension. It should start with the 'c_' prefix. If not present, the prefix will be added automatically. schema: type: string - name: event in: query description: The types of event where this dimension will be added. required: true schema: uniqueItems: true type: array items: type: string enum: - searches - clicks - custom_events - name: updatePastEvents in: query description: Whether to update the custom dimension in past events. deprecated: true schema: type: boolean default: false requestBody: description: The custom dimension information. content: application/json: schema: $ref: '#/components/schemas/CustomDimensionModelV15' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/DimensionResponseV14' deprecated: true /v14/dimensions/custom/{apiName}: get: tags: - Dimensions API - Version 14 summary: Get a Custom Dimension description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_dimensions_custom_{apiName} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: apiName in: path description: Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DimensionResponseV14' deprecated: true put: tags: - Dimensions API - Version 14 summary: Create or Edit a Custom Dimension description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: put__v14_dimensions_custom_{apiName} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: apiName in: path description: Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension. required: true schema: type: string - name: updatePastEvents in: query description: Whether to update the custom dimension in past events. deprecated: true schema: type: boolean default: false requestBody: description: The custom dimension information. content: application/json: schema: $ref: '#/components/schemas/CustomDimensionModelV14' required: true responses: '200': description: The custom dimension has been edited content: application/json: schema: $ref: '#/components/schemas/DimensionResponseV14' '201': description: The custom dimension has been created content: application/json: schema: $ref: '#/components/schemas/DimensionResponseV14' deprecated: true delete: tags: - Dimensions API - Version 14 summary: Get a Custom Dimension description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: delete__v14_dimensions_custom_{apiName} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: apiName in: path description: Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension. required: true schema: type: string responses: '204': description: No content deprecated: true /v14/dimensions/custom/{event}/suggestions: get: tags: - Dimensions API - Version 14 summary: Get a List of Dimensions That Have Data but Are Not Created Yet description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_dimensions_custom_{event}_suggestions parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' schema: type: string - name: event in: path description: The type of event for which to look for suggestions. required: true schema: type: string enum: - searches - clicks - custom_events - name: includeValueSamples in: query description: Whether value samples should be included in the response. schema: type: boolean default: true - name: depth in: query description: The number of events to look at when getting suggestions. A larger depth means more suggestions but also slower performance. schema: type: integer format: int32 default: 1000 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CustomDimensionSuggestionsResponseV14' deprecated: true /v14/dimensions/custom/monitoring/health: get: tags: - Dimensions API - Version 14 summary: Health Check for the Custom Dimensions Service description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_dimensions_custom_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' deprecated: true /v14/dimensions/custom/status: get: tags: - Dimensions API - Version 14 summary: Get the Custom Dimensions Service Status description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_dimensions_custom_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' deprecated: true /v14/dimensions/custom/{dimension}/values: get: tags: - Dimensions API - Version 14 summary: Get the Values for a Custom Dimension description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_dimensions_custom_{dimension}_values parameters: - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string default: Z - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: dimension in: path description: The dimensions to fetch. required: true schema: type: string - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: p in: query description: The response's page to access, starting at 1. schema: type: integer format: int32 - name: n in: query description: The number of result to include in a page. schema: type: integer format: int32 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DimensionValuesResponseV14' deprecated: true /v14/dimensions/{apiName}: get: tags: - Dimensions API - Version 14 summary: Get a Dimension description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_dimensions_{apiName} parameters: [] responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DimensionResponseV14' deprecated: true /v14/dimensions: get: tags: - Dimensions API - Version 14 summary: Get All the Dimensions description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_dimensions parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: includeOnlyParents in: query description: This will filter out dimensions which are covered by others. Only parent/master dimensions will be output schema: type: boolean default: false - name: includeCustom in: query description: Whether to include custom dimensions within the results. schema: type: boolean default: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/DimensionResponseV14' deprecated: true /v14/dimensions/monitoring/health: get: tags: - Dimensions API - Version 14 summary: Health Check for the Dimensions Service description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_dimensions_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' deprecated: true /v14/dimensions/status: get: tags: - Dimensions API - Version 14 summary: Get the Dimensions Service Status description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_dimensions_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' deprecated: true /v14/dimensions/{dimension}/values: get: tags: - Dimensions API - Version 14 summary: Get the Values for a Dimension description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_dimensions_{dimension}_values parameters: - name: from in: query description: from schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string default: Z - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: dimension in: path description: The dimensions to fetch. required: true schema: type: string - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: p in: query description: The response's page to access, starting at 1. schema: type: integer format: int32 - name: n in: query description: The number of result to include in a page. schema: type: integer format: int32 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DimensionValuesResponseV14' deprecated: true /v14/exports/{exportId}: get: tags: - Exports API - Version 14 summary: Get Information on an Export description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_exports_{exportId} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: exportId in: path description: The export's unique identifier. required: true schema: type: string - name: redirect in: query description: "Whether to return a HTTP redirect to the actual file.\n\n Note: for technical reasons, setting this\ \ parameter to true will yield an error when calling the endpoint through Swagger user interface." schema: type: boolean default: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportResponseV14' deprecated: true delete: tags: - Exports API - Version 14 summary: Delete an Export description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: delete__v14_exports_{exportId} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: exportId in: path description: The export's unique identifier. required: true schema: type: string responses: '204': description: No content deprecated: true /v14/exports/estimate: get: tags: - Exports API - Version 14 summary: Estimate the Number of Rows in an Export description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_exports_estimate parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: f in: query description: The filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fs in: query description: The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fc in: query description: The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportEstimateResponseV14' deprecated: true /v14/exports/visits/estimate: get: tags: - Exports API - Version 14 summary: Estimate the Number of Rows in a Visit Export description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_exports_visits_estimate parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fn in: query description: The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportEstimateResponseV14' deprecated: true /v14/exports: get: tags: - Exports API - Version 14 summary: Lists All Exports description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_exports parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/ExportResponseV14' deprecated: true post: tags: - Exports API - Version 14 summary: Generate an Export description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: post__v14_exports parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: f in: query description: The filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fs in: query description: The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fc in: query description: The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: filename in: query description: Can only contain US-ASCII characters. If none is supplied it will be set to the export's id. schema: type: string - name: format in: query description: The format of the generated CSV files. schema: type: string enum: - EXCEL - NO_NEWLINE - EXCEL,NO_NEWLINE default: EXCEL responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ExportResponseV14' deprecated: true /v14/exports/visits: post: tags: - Exports API - Version 14 summary: Generate a Visit Export description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: post__v14_exports_visits parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fn in: query description: The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: filename in: query description: Can only contain US-ASCII characters. If none is supplied it will be set to the export's id. schema: type: string - name: d in: query description: Export's description. schema: type: string - name: format in: query description: The format of the generated CSV files. schema: type: string enum: - EXCEL - NO_NEWLINE - EXCEL,NO_NEWLINE default: EXCEL responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ExportResponseV14' deprecated: true /v14/exports/monitoring/health: get: tags: - Exports API - Version 14 summary: Health Check for the Exports Service description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_exports_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' deprecated: true /v14/exports/status: get: tags: - Exports API - Version 14 summary: Get the Exports Service Status description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_exports_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' deprecated: true /v14/filters/permissions: get: tags: - Filters API - Version 14 summary: Get All the Permission Filters description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_filters_permissions parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FiltersResponseV14' deprecated: true post: tags: - Filters API - Version 14 summary: Create a Permission Filter description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: post__v14_filters_permissions parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The filter configuration content: application/json: schema: $ref: '#/components/schemas/FilterModelV14' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/FilterIdResponseV14' deprecated: true /v14/filters/reporting: get: tags: - Filters API - Version 14 summary: Get All the Reporting Filters description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_filters_reporting parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FiltersResponseV14' deprecated: true post: tags: - Filters API - Version 14 summary: Create a Reporting Filter description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: post__v14_filters_reporting parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The filter configuration content: application/json: schema: $ref: '#/components/schemas/FilterModelV14' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/FilterIdResponseV14' deprecated: true /v14/filters/permissions/{filterId}: get: tags: - Filters API - Version 14 summary: Get a Permission Filter description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_filters_permissions_{filterId} parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FilterResponseV14' deprecated: true put: tags: - Filters API - Version 14 summary: Update a Permission Filter description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: put__v14_filters_permissions_{filterId} parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The filter configuration content: application/json: schema: $ref: '#/components/schemas/FilterModelV14' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FilterIdResponseV14' deprecated: true delete: tags: - Filters API - Version 14 summary: Deletes the Specified Permission Filter description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: delete__v14_filters_permissions_{filterId} parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '204': description: No content deprecated: true /v14/filters/reporting/{filterId}: get: tags: - Filters API - Version 14 summary: Gets the Specified Reporting Filter description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_filters_reporting_{filterId} parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FilterResponseV14' deprecated: true put: tags: - Filters API - Version 14 summary: Update a Reporting Filter description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: put__v14_filters_reporting_{filterId} parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The filter configuration content: application/json: schema: $ref: '#/components/schemas/FilterModelV14' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FilterIdResponseV14' deprecated: true delete: tags: - Filters API - Version 14 summary: Deletes the Specified Reporting Filter description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: delete__v14_filters_reporting_{filterId} parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '204': description: No content deprecated: true /v14/filters/monitoring/health: get: tags: - Filters API - Version 14 summary: Health Check for the Filter Service description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_filters_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' deprecated: true /v14/filters/status: get: tags: - Filters API - Version 14 summary: Gets the Status of the Filter Service description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_filters_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' deprecated: true /v14/filters/permissions/{filterId}/users: get: tags: - Filters API - Version 14 summary: Get the Users of a Permission Filter description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_filters_permissions_{filterId}_users parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/UserResponseV14' deprecated: true put: tags: - Filters API - Version 14 summary: Set the Users of a Permission Filter description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: put__v14_filters_permissions_{filterId}_users parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The users to set the permission on. content: application/json: schema: uniqueItems: true type: array items: type: string required: true responses: '204': description: No content deprecated: true /v14/metrics/{metricName}: get: tags: - Metrics API - Version 14 summary: Get a Metric description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_metrics_{metricName} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: metricName in: path description: metricName required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MetricResponseV14' deprecated: true /v14/metrics: get: tags: - Metrics API - Version 14 summary: Get All the Metrics description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_metrics parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MetricsResponseV14' deprecated: true /v14/metrics/monitoring/health: get: tags: - Metrics API - Version 14 summary: Health Check for the Metrics Service description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_metrics_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' deprecated: true /v14/metrics/status: get: tags: - Metrics API - Version 14 summary: Get the Metrics Service Status description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_metrics_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' deprecated: true /v14/reports: get: tags: - Reports API - Version 14 summary: Get the Persisted Reports of One or All Types description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_reports parameters: - name: type in: query description: The type of the report. Must be either 'explorer' or 'dashboard'. schema: type: string enum: - DASHBOARD - EXPLORER - EXPLORER,DASHBOARD - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: includeConfig in: query description: Whether to include the detailed configuration of the report in the response. schema: type: boolean default: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReportsResponseV14' deprecated: true post: tags: - Reports API - Version 14 summary: Create a Report description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: post__v14_reports parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The report configuration content: application/json: schema: $ref: '#/components/schemas/ReportModelV14' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ReportIdResponseV14' deprecated: true /v14/reports/{reportId}: get: tags: - Reports API - Version 14 summary: Get a Report description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_reports_{reportId} parameters: - name: reportId in: path description: The unique identifier of a report. This id is generated by the server when creating a report. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReportResponseV14' deprecated: true put: tags: - Reports API - Version 14 summary: Update a Report description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: put__v14_reports_{reportId} parameters: - name: reportId in: path description: The unique identifier of a report. This id is generated by the server when creating a report. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The report configuration content: application/json: schema: $ref: '#/components/schemas/ReportModelV14' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReportIdResponseV14' deprecated: true delete: tags: - Reports API - Version 14 summary: Delete a Report description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: delete__v14_reports_{reportId} parameters: - name: reportId in: path description: The unique identifier of a report. This id is generated by the server when creating a report. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '204': description: No content deprecated: true /v14/reports/monitoring/health: get: tags: - Reports API - Version 14 summary: Health Check for the Reports Service description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_reports_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' deprecated: true /v14/reports/status: get: tags: - Reports API - Version 14 summary: Get the Reports Service Status description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_reports_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' deprecated: true /v14/reports/{reportId}/users: get: tags: - Reports API - Version 14 summary: Gets the Users That Can View the Specified Report. description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_reports_{reportId}_users parameters: - name: reportId in: path description: The unique identifier of a report. This id is generated by the server when creating a report. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReportUsersResponseV14' deprecated: true put: tags: - Reports API - Version 14 summary: Set the Users Who Are Allowed to View a Report description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: put__v14_reports_{reportId}_users parameters: - name: reportId in: path description: The unique identifier of a report. This id is generated by the server when creating a report. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The IDs of the allowed users. content: application/json: schema: uniqueItems: true type: array items: type: string required: true responses: '204': description: No content deprecated: true /v14/stats/combinedData: get: tags: - Statistics API - Version 14 summary: Get Metrics Combined with Dimensions for a Date Range description: 'This endpoint is deprecated and will be removed on October 1st, 2024. There is one value of each metric for every possible dimension combination.' operationId: get__v14_stats_combinedData parameters: - name: m in: query description: The metrics to fetch. required: true schema: type: array items: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string default: Z - name: d in: query description: Timezone used for calculations. schema: type: array items: type: string default: Z default: Z - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fm in: query description: The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: s in: query description: The field to order the results by. It must be a dimension, metric or custom dimension that was specified in the 'm' or the 'd' parameter. schema: type: string - name: p in: query description: The response's page to access, starting at 1. schema: type: integer format: int32 - name: n in: query description: The number of result to include in a page. schema: type: integer format: int32 - name: asc in: query description: Whether to sort by ascending order. schema: type: boolean default: true - name: includeMetadata in: query description: Whether to include metadata regarding the results (total count and unique counts, if applicable). schema: type: boolean default: true - name: format in: query description: The format of the response. Default is JSON. schema: type: string enum: - JSON - CSV - JSON,CSV default: JSON - name: bindOnLastSearch in: query description: bindOnLastSearch schema: type: boolean default: true - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CombinedDataResponseV14' text/csv: schema: $ref: '#/components/schemas/CombinedDataResponseV14' deprecated: true /v14/stats/trends: get: tags: - Statistics API - Version 14 summary: Get Trends of a Metric Combined with Dimensions for a Date Range description: 'This endpoint is deprecated and will be removed on October 1st, 2024. There is one value of each metric for every possible dimension combination.' operationId: get__v14_stats_trends parameters: - name: m in: query description: The metrics to fetch. required: true schema: type: array items: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: previousFrom in: query description: The beginning date of the previous date range, when reporting trends. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'. If not specified, it will be the 'from' date minus the duration of the 'from'-'to' date range. schema: type: string - name: previousTo in: query description: The end date of the previous date range, when reporting trends. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'. If not specified, it will be the 'to' date minus the duration of the 'from'-'to' date range. schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string default: Z - name: d in: query description: Timezone used for calculations. schema: type: array items: type: string default: Z default: Z - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fm in: query description: The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: s in: query description: The field to order the results by. It must be a dimension, metric or custom dimension that was specified in the 'm' or the 'd' parameter. schema: type: string - name: p in: query description: The response's page to access, starting at 1. schema: type: integer format: int32 - name: n in: query description: The number of result to include in a page. schema: type: integer format: int32 - name: asc in: query description: Whether to sort by ascending order. schema: type: boolean default: true - name: includeMetadata in: query description: Whether to include metadata regarding the results (total count and unique counts, if applicable). schema: type: boolean default: true - name: format in: query description: The format of the response. Default is JSON. schema: type: string enum: - JSON - CSV default: JSON - name: bindOnLastSearch in: query description: bindOnLastSearch schema: type: boolean default: true - name: t in: query description: The trends to caculate. required: true schema: type: array items: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CombinedDataResponseV14' text/csv: schema: $ref: '#/components/schemas/CombinedDataResponseV14' deprecated: true /v14/stats/globalData: get: tags: - Statistics API - Version 14 summary: Get Global Data for Each Metric for a Date Range description: 'This endpoint is deprecated and will be removed on October 1st, 2024. Global data contain the total, the daily peak and the daily average.' operationId: get__v14_stats_globalData parameters: - name: m in: query description: The metrics to fetch. required: true schema: type: array items: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string default: Z - name: d in: query description: The dimensions to fetch. Required when the Activity metric is requested as it has to be based on a dimension. schema: type: array items: type: string - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: i in: query description: The interval on which data will be grouped. Default value is DAY. schema: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - MINUTE,HOUR,DAY,WEEK,MONTH default: DAY - name: bindOnLastSearch in: query description: bindOnLastSearch schema: type: boolean default: true - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GlobalAggregatedDataResponseV14' deprecated: true /v14/stats/graphDataPoints: get: tags: - Statistics API - Version 14 summary: Get Graph Data Points for the Metrics for a Date Range description: 'This endpoint is deprecated and will be removed on October 1st, 2024. There is one data point per interval per metric. The interval can be specified with the ''i'' query parameter.' operationId: get__v14_stats_graphDataPoints parameters: - name: m in: query description: The metrics to fetch. required: true schema: type: array items: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string default: Z - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: i in: query description: The interval on which data will be grouped. Default value is DAY. schema: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - MINUTE,HOUR,DAY,WEEK,MONTH default: DAY - name: bindOnLastSearch in: query description: bindOnLastSearch schema: type: boolean default: true - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GraphAggregatedDataResponseV14' deprecated: true /v14/stats/monitoring/health: get: tags: - Statistics API - Version 14 summary: Health Check for the Statistics Service description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_stats_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' deprecated: true /v14/stats/status: get: tags: - Statistics API - Version 14 summary: Get the Statistics Service Status description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_stats_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' deprecated: true /v14/stats/visits: get: tags: - Statistics API - Version 14 summary: Get the Details of the Visits Matching the Specified Criteria description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_stats_visits parameters: - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string default: Z - name: d in: query description: The dimensions to fetch. schema: type: array items: type: string - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fn in: query description: The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: s in: query description: The field to order the results by. It must be a dimension, metric or custom dimension that was specified in the 'm' or the 'd' parameter. schema: type: string default: eventDatetime - name: p in: query description: The response's page to access, starting at 1. schema: type: integer format: int32 - name: n in: query description: The number of result to include in a page. schema: type: integer format: int32 - name: asc in: query description: Whether to sort by ascending order. schema: type: boolean default: false - name: includeMetadata in: query description: Whether to include metadata regarding the results (total count and unique counts, if applicable). schema: type: boolean default: true - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VisitsStatisticsResponseV14' deprecated: true post: tags: - Statistics API - Version 14 summary: Force a Visit View Update description: 'This endpoint is deprecated and will be removed on October 1st, 2024. Global data contain the total, the daily peak and the daily average.' operationId: post__v14_stats_visits parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '204': description: No content deprecated: true /v14/users/{userId}/filters: get: tags: - Users API - Version 14 summary: Get the Data Level Filters That Apply to a User description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_users_{userId}_filters parameters: - name: userId in: path description: The unique identifier of a user. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FiltersResponseV14' deprecated: true put: tags: - Users API - Version 14 summary: Set the Filters That Will Be Applied to a User Query description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: put__v14_users_{userId}_filters parameters: - name: userId in: path description: The unique identifier of a user. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The filters that will be applied to the user. Must be a persisted filter ID content: application/json: schema: uniqueItems: true type: array items: $ref: '#/components/schemas/FilterValueModelV14' required: true responses: '204': description: No content deprecated: true /v14/users/{userId}/reports: get: tags: - Users API - Version 14 summary: Get the Reports That a User Can Access description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_users_{userId}_reports parameters: - name: userId in: path description: The unique identifier of a user. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: includeConfig in: query description: Whether to include the detailed configuration of the report in the response. schema: type: boolean default: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReportsResponseV14' deprecated: true put: tags: - Users API - Version 14 summary: Set Which Reports a User Can Access description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: put__v14_users_{userId}_reports parameters: - name: userId in: path description: The unique identifier of a user. required: true schema: type: string - name: org in: query description: The unique identifier of a user. schema: type: string requestBody: description: The IDs of the reports the user can access content: application/json: schema: uniqueItems: true type: array items: type: string required: true responses: '204': description: No content deprecated: true /v14/users/monitoring/health: get: tags: - Users API - Version 14 summary: Health Check for the Users Service description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_users_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' deprecated: true /v14/users/status: get: tags: - Users API - Version 14 summary: Get the Users Service Status description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_users_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' deprecated: true /v14/users/{userId}: get: tags: - Users API - Version 14 summary: Get a User description: This endpoint is deprecated and will be removed on October 1st, 2024. operationId: get__v14_users_{userId} parameters: - name: userId in: path description: The unique identifier of a user. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponseV14' deprecated: true /v15/admin/account: get: tags: - Administration API - Version 15 summary: Get an Account operationId: get__v15_admin_account parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountResponseV15' put: tags: - Administration API - Version 15 summary: Edit an Account operationId: put__v15_admin_account parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The account information content: application/json: schema: $ref: '#/components/schemas/AccountInfoModelV15' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountResponseV15' /v15/admin/account/strictValidationTest: get: tags: - Administration API - Version 15 summary: Get Example Values That Would Be Rejected by Strict Validation for the Specified Dimension description: This endpoint is deprecated and will be removed in April 2025. operationId: get__v15_admin_account_strictValidationTest parameters: - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: d in: query description: The dimension to fetch. required: true schema: type: string - name: p in: query description: The response's page to access, starting at 1. schema: type: integer format: int32 - name: n in: query description: The number of results to include in a page. schema: type: integer format: int32 - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StrictValidationTestResponseV15' deprecated: true /v15/datahealth/events/payload: get: tags: - Data Health API - Version 15 summary: Get the Payload of an Event. operationId: get__v15_datahealth_events_payload parameters: - name: timestamp in: query description: The timestamp of the event. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: eventId in: query description: The id of the event for which to return information. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetEventPayloadResponseV15' /v15/datahealth/events/problems: get: tags: - Data Health API - Version 15 summary: Get Problems About Events operationId: get__v15_datahealth_events_problems parameters: - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: eventType in: query description: A set of event types for which the events will be returned. schema: type: array items: type: string - name: searchHub in: query description: A set of search hubs for which the events will be returned. schema: type: array items: type: string - name: trackingId in: query description: The tracking IDs for which the results should be returned. schema: type: array items: type: string - name: page in: query description: The response's page to access, starting at 0. schema: type: integer format: int32 default: 0 - name: perPage in: query description: The number of results to include in a page. schema: type: integer format: int32 default: 50 - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EventProblemsResponseV15' '404': description: PAGE_NOT_FOUND /v15/datahealth/criteria/failedInstances: get: tags: - Data Health API - Version 15 summary: Get Failed Instances for a Data Health Criterion operationId: get__v15_datahealth_criteria_failedInstances parameters: - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: criterionId in: query description: The data health criterion for which the failed instances should be returned. required: true schema: type: string - name: group in: query description: The group for which data health information should be returned. required: true schema: type: string - name: scopeValue in: query description: The value of the criterion scope for which failed instances should be returned. For example, if the scope of a rule is 'EVENT', the scope value could be 'Click', 'Search', etc. The failed instances would contain sample events of the specified type. schema: type: string - name: trackingId in: query description: The tracking IDs for which the results should be returned. schema: type: array items: type: string - name: page in: query description: The response's page to access, starting at 0. schema: type: integer format: int32 default: 0 - name: perPage in: query description: The number of results to include in a page. schema: type: integer format: int32 default: 50 - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FailedInstancesResponseV15' /v15/datahealth/groups/detail: get: tags: - Data Health API - Version 15 summary: Get Detailed Information About a Data Health Group operationId: get__v15_datahealth_groups_detail parameters: - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: group in: query description: The group for which data health information should be returned. required: true schema: type: string - name: category in: query description: The categories of rules for which data health should be displayed. schema: type: array items: type: string - name: feature in: query description: The feature for which data health should be computed. schema: type: array items: type: string - name: trackingId in: query description: The tracking IDs for which the results should be returned. schema: type: array items: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GroupDetailResponseV15' /v15/datahealth/groups: get: tags: - Data Health API - Version 15 summary: Get a Listing of Data Health Groups operationId: get__v15_datahealth_groups parameters: - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: category in: query description: The categories of rules for which data health should be displayed. schema: type: array items: type: string - name: feature in: query description: The feature for which data health should be computed. schema: type: array items: type: string - name: trackingId in: query description: The tracking IDs for which the results should be returned. schema: type: array items: type: string - name: page in: query description: The response's page to access, starting at 0. schema: type: integer format: int32 default: 0 - name: perPage in: query description: The number of results to include in a page. schema: type: integer format: int32 default: 10 - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: showEmptyGroups in: query description: Whether or not groups with zero event validated should be shown schema: type: boolean default: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GroupListingResponseV15' /v15/datahealth/overview: get: tags: - Data Health API - Version 15 summary: Get the Data Health Overview operationId: get__v15_datahealth_overview parameters: - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: category in: query description: The categories of rules for which data health should be displayed. schema: type: array items: type: string - name: feature in: query description: The feature for which data health should be computed. schema: type: array items: type: string - name: trackingId in: query description: The tracking IDs for which the results should be returned. schema: type: array items: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/OverviewResponseV15' /v15/datahealth/status: get: tags: - Data Health API - Version 15 summary: Get the Data Health Service Status operationId: get__v15_datahealth_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/datahealth/events: get: tags: - Data Health API - Version 15 summary: Get Health Information About Events operationId: get__v15_datahealth_events parameters: - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: clientId in: query description: A set of client IDs for which the events will be returned. schema: type: array items: type: string - name: visitId in: query description: A set of visit IDs for which the events will be returned. schema: type: array items: type: string - name: eventSource in: query description: A set of event sources for which the events will be returned. schema: type: array items: type: string - name: eventType in: query description: A set of event types for which the events will be returned. schema: type: array items: type: string - name: searchHub in: query description: A set of search hubs for which the events will be returned. schema: type: array items: type: string - name: trackingId in: query description: The tracking IDs for which the results should be returned. schema: type: array items: type: string - name: healthStatus in: query description: A health status for which the events will be returned. schema: type: string enum: - VALID - INVALID - name: page in: query description: The response's page to access, starting at 0. schema: type: integer format: int32 default: 0 - name: perPage in: query description: The number of results to include in a page. schema: type: integer format: int32 default: 50 - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListEventsResponseV15' '404': description: PAGE_NOT_FOUND /v15/datahealth/facets: get: tags: - Data Health API - Version 15 summary: List Facet Values for Event Browser operationId: get__v15_datahealth_facets parameters: - name: facet in: query description: The facet for which the values should be listed required: true schema: type: string enum: - EVENT_SOURCE - EVENT_TYPE - HEALTH_STATUS - SEARCH_HUB - TRACKING_ID - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: clientId in: query description: A set of client IDs for which the events will be returned. schema: type: array items: type: string - name: visitId in: query description: A set of visit IDs for which the events will be returned. schema: type: array items: type: string - name: eventSource in: query description: A set of event sources for which the events will be returned. schema: type: array items: type: string - name: eventType in: query description: A set of event types for which the events will be returned. schema: type: array items: type: string - name: searchHub in: query description: A set of search hubs for which the events will be returned. schema: type: array items: type: string - name: trackingId in: query description: The tracking IDs for which the results should be returned. schema: type: array items: type: string - name: healthStatus in: query description: A health status for which the events will be returned. schema: type: string enum: - VALID - INVALID - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListFacetValuesResponseV15' /v15/dimensions/custom: get: tags: - Dimensions API - Version 15 summary: Get All the Custom Dimensions operationId: get__v15_dimensions_custom parameters: - name: includeOnlyParents in: query description: This will filter out dimensions which are covered by others. Only parent/master dimensions will be output schema: type: boolean default: false - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/DimensionResponseV15' post: tags: - Dimensions API - Version 15 summary: Create a Custom Dimension operationId: post__v15_dimensions_custom parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: name in: query description: The name of the custom dimension. It should start with the 'c_' prefix. If not present, the prefix will be added automatically. schema: type: string - name: event in: query description: The types of event where this dimension will be added. required: true schema: uniqueItems: true type: array items: type: string enum: - searches - clicks - custom_events - name: updatePastEvents in: query description: Whether to update the custom dimension in past events. deprecated: true schema: type: boolean default: false requestBody: description: The custom dimension information. content: application/json: schema: $ref: '#/components/schemas/CustomDimensionModelV15' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/DimensionResponseV15' /v15/dimensions/custom/{apiName}: get: tags: - Dimensions API - Version 15 summary: Get a Custom Dimension operationId: get__v15_dimensions_custom_{apiName} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: apiName in: path description: Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DimensionResponseV15' put: tags: - Dimensions API - Version 15 summary: Create or Edit a Custom Dimension operationId: put__v15_dimensions_custom_{apiName} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: apiName in: path description: Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension. required: true schema: type: string - name: updatePastEvents in: query description: Whether to update the custom dimension in past events. deprecated: true schema: type: boolean default: false requestBody: description: The custom dimension information. content: application/json: schema: $ref: '#/components/schemas/CustomDimensionModelV15' required: true responses: '200': description: The custom dimension has been edited content: application/json: schema: $ref: '#/components/schemas/DimensionResponseV15' '201': description: The custom dimension has been created content: application/json: schema: $ref: '#/components/schemas/DimensionResponseV15' delete: tags: - Dimensions API - Version 15 summary: Delete a Custom Dimension operationId: delete__v15_dimensions_custom_{apiName} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: apiName in: path description: Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension. required: true schema: type: string responses: '204': description: No content /v15/dimensions/custom/{event}/suggestions: get: tags: - Dimensions API - Version 15 summary: Get a List of Dimensions That Have Data but Are Not Created Yet operationId: get__v15_dimensions_custom_{event}_suggestions parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' schema: type: string - name: event in: path description: The type of event for which to look for suggestions. required: true schema: type: string enum: - searches - clicks - custom_events - name: includeValueSamples in: query description: Whether value samples should be included in the response. schema: type: boolean default: true - name: depth in: query description: The number of events to look at when getting suggestions. A larger depth means more suggestions but also slower performance. schema: type: integer format: int32 default: 1000 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CustomDimensionSuggestionsResponseV15' /v15/dimensions/custom/monitoring/health: get: tags: - Dimensions API - Version 15 summary: Health Check for the Custom Dimensions Service operationId: get__v15_dimensions_custom_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/dimensions/custom/status: get: tags: - Dimensions API - Version 15 summary: Get the Custom Dimensions Service Status operationId: get__v15_dimensions_custom_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/dimensions/custom/{dimension}/values: get: tags: - Dimensions API - Version 15 summary: Get the Values for a Custom Dimension operationId: get__v15_dimensions_custom_{dimension}_values parameters: - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string default: Z - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: dimension in: path description: The dimensions to fetch. required: true schema: type: string - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: p in: query description: The response's page to access, starting at 1. schema: type: integer format: int32 - name: n in: query description: The number of results to include in a page. schema: type: integer format: int32 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DimensionValuesResponseV15' /v15/dimensions/{apiName}: get: tags: - Dimensions API - Version 15 summary: Get a Dimension operationId: get__v15_dimensions_{apiName} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: apiName in: path description: Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DimensionResponseV15' /v15/dimensions: get: tags: - Dimensions API - Version 15 summary: Get All the Dimensions operationId: get__v15_dimensions parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: includeOnlyParents in: query description: This will filter out dimensions which are covered by others. Only parent/master dimensions will be output schema: type: boolean default: false - name: includeCustom in: query description: Whether to include custom dimensions within the results. schema: type: boolean default: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/DimensionResponseV15' /v15/dimensions/exportables: get: tags: - Dimensions API - Version 15 summary: Get All the Exportable Dimensions operationId: get__v15_dimensions_exportables parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: includeOnlyParents in: query description: This will filter out dimensions which are covered by others. Only parent/master dimensions will be output schema: type: boolean default: false - name: includeCustom in: query description: Whether to include custom dimensions within the results. schema: type: boolean default: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/DimensionResponseV15' /v15/dimensions/monitoring/health: get: tags: - Dimensions API - Version 15 summary: Health Check for the Dimensions Service operationId: get__v15_dimensions_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/dimensions/status: get: tags: - Dimensions API - Version 15 summary: Get the Dimensions Service Status operationId: get__v15_dimensions_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/dimensions/{dimension}/values: get: tags: - Dimensions API - Version 15 summary: Get the Values for a Dimension operationId: get__v15_dimensions_{dimension}_values parameters: - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string default: Z - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: dimension in: path description: The dimensions to fetch. required: true schema: type: string - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: p in: query description: The response's page to access, starting at 1. schema: type: integer format: int32 - name: n in: query description: The number of results to include in a page. schema: type: integer format: int32 - name: cached in: query description: cached schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DimensionValuesResponseV15' /v15/exports/schedules: get: tags: - Exports API - Version 15 summary: Get All the Export Schedules operationId: get__v15_exports_schedules parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/ExportScheduleResponseV15' post: tags: - Exports API - Version 15 summary: Create an Export Schedule operationId: post__v15_exports_schedules parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: Information about the requested export schedule. content: application/json: schema: $ref: '#/components/schemas/ExportScheduleModelV15' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ExportScheduleResponseV15' /v15/exports/{exportId}: get: tags: - Exports API - Version 15 summary: Get Information on an Export operationId: get__v15_exports_{exportId} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: exportId in: path description: The export's unique identifier. required: true schema: type: string - name: redirect in: query description: "Whether to return a HTTP redirect to the actual file.\n\n Note: for technical reasons, setting this\ \ parameter to true will yield an error when calling the endpoint through Swagger user interface." schema: type: boolean default: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportResponseV15' '303': description: Responds with See Other, if the redirect parameter is used delete: tags: - Exports API - Version 15 summary: Delete an Export operationId: delete__v15_exports_{exportId} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: exportId in: path description: The export's unique identifier. required: true schema: type: string responses: '204': description: No content /v15/exports/schedules/{exportScheduleId}: get: tags: - Exports API - Version 15 summary: Get Information on an Export Schedule operationId: get__v15_exports_schedules_{exportScheduleId} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: exportScheduleId in: path description: The export schedule's unique identifier. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportScheduleResponseV15' put: tags: - Exports API - Version 15 summary: Update an Existing Export Schedule operationId: put__v15_exports_schedules_{exportScheduleId} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: exportScheduleId in: path description: The export schedule's unique identifier. required: true schema: type: string requestBody: description: Information about the requested export schedule. content: application/json: schema: $ref: '#/components/schemas/ExportScheduleModelV15' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportScheduleResponseV15' delete: tags: - Exports API - Version 15 summary: Delete an Export Schedule operationId: delete__v15_exports_schedules_{exportScheduleId} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: exportScheduleId in: path description: The export schedule's unique identifier. required: true schema: type: string responses: '204': description: No content /v15/exports/estimate: get: tags: - Exports API - Version 15 summary: Estimate the Number of Rows in an Export operationId: get__v15_exports_estimate parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: tables in: query description: The tables that will be exported. If not provided, all tables will be exported. schema: type: array items: type: string enum: - SEARCHES - CLICKS - CUSTOM_EVENTS - KEYWORDS - GROUPS - ALL_EVENTS - name: f in: query description: The filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fs in: query description: The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fc in: query description: The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportEstimateResponseV15' /v15/exports/visits/estimate: get: tags: - Exports API - Version 15 summary: Estimate the Number of Rows in a Visit Export operationId: get__v15_exports_visits_estimate parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: hideEventFilters in: query description: Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fn in: query description: The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportEstimateResponseV15' /v15/exports: get: tags: - Exports API - Version 15 summary: Lists All Exports operationId: get__v15_exports parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/ExportResponseV15' post: tags: - Exports API - Version 15 summary: Generate an Export operationId: post__v15_exports parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: f in: query description: The filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fs in: query description: The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fc in: query description: The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: filename in: query description: A file name for the export. Can only contain US-ASCII characters. If none is supplied it will be set to the export's id. schema: type: string - name: d in: query description: Export's description. schema: type: string - name: dimensions in: query description: The dimensions that will be exported. If not provided, all dimensions will be exported. schema: type: array items: type: string - name: tables in: query description: The tables that will be exported. If not provided, all tables will be exported. schema: type: array items: type: string enum: - SEARCHES - CLICKS - CUSTOM_EVENTS - KEYWORDS - GROUPS - ALL_EVENTS - name: format in: query description: The format of the generated CSV files. schema: type: string enum: - EXCEL - NO_NEWLINE default: EXCEL - name: useDisplayNames in: query description: Whether to use the display names in the export's header. If false, the api names will be used. schema: type: boolean default: false responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ExportResponseV15' /v15/exports/visits: post: tags: - Exports API - Version 15 summary: Generate a Visit Export operationId: post__v15_exports_visits parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: hideEventFilters in: query description: Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fn in: query description: The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: filename in: query description: A file name for the export. Can only contain US-ASCII characters. If none is supplied it will be set to the export's id. schema: type: string - name: d in: query description: Export's description. schema: type: string - name: dimensions in: query description: The dimensions that will be exported. If not provided, all dimensions will be exported. schema: type: array items: type: string - name: format in: query description: The format of the generated CSV files. schema: type: string enum: - EXCEL - NO_NEWLINE - EXCEL,NO_NEWLINE default: EXCEL - name: ordered in: query description: Whether to order the rows by datetime in the export. If the number of rows exported is to great, this parameter will be ignored and data will be unsorted. schema: type: boolean default: true - name: useDisplayNames in: query description: Whether to use the display names in the export's header. If false, the api names will be used. schema: type: boolean default: false responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ExportResponseV15' /v15/exports/visits/create: post: tags: - Exports API - Version 15 summary: Generate a Visit Export (with Parameters as Request Body) operationId: post__v15_exports_visits_create parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportVisitsModelV15' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ExportResponseV15' /v15/exports/create: post: tags: - Exports API - Version 15 summary: Generate an Export (with Parameters as Request Body) operationId: post__v15_exports_create parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportModelV15' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ExportResponseV15' /v15/exports/{exportId}/downloadlink: get: tags: - Exports API - Version 15 summary: Get the Download Link of an Export operationId: get__v15_exports_{exportId}_downloadlink parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: exportId in: path description: The export's unique identifier. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportDownloadLinkResponseV15' /v15/exports/rowLimit: get: tags: - Exports API - Version 15 summary: Get the Maximum Allowed Number of Rows an Export Can Have operationId: get__v15_exports_rowLimit parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExportRowCountLimitV15' /v15/exports/schedules/{exportScheduleId}/exports: get: tags: - Exports API - Version 15 summary: Get Exports Generated by the Specified Schedule operationId: get__v15_exports_schedules_{exportScheduleId}_exports parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: exportScheduleId in: path description: The export schedule's unique identifier. required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/ExportResponseV15' /v15/exports/monitoring/health: get: tags: - Exports API - Version 15 summary: Health Check for the Exports Service operationId: get__v15_exports_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/exports/status: get: tags: - Exports API - Version 15 summary: Get the Exports Service Status operationId: get__v15_exports_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/filters/permissions: get: tags: - Filters API - Version 15 summary: Get All the Permission Filters operationId: get__v15_filters_permissions parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FiltersResponseV15' post: tags: - Filters API - Version 15 summary: Create a Permission Filter operationId: post__v15_filters_permissions parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The filter configuration content: application/json: schema: $ref: '#/components/schemas/FilterModelV15' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/FilterIdResponseV15' /v15/filters/reporting: get: tags: - Filters API - Version 15 summary: Get All the Reporting Filters operationId: get__v15_filters_reporting parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FiltersResponseV15' post: tags: - Filters API - Version 15 summary: Create a Reporting Filter operationId: post__v15_filters_reporting parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The filter configuration content: application/json: schema: $ref: '#/components/schemas/FilterModelV15' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/FilterIdResponseV15' /v15/filters/permissions/{filterId}: get: tags: - Filters API - Version 15 summary: Get a Permission Filter operationId: get__v15_filters_permissions_{filterId} parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FilterResponseV15' put: tags: - Filters API - Version 15 summary: Update a Permission Filter operationId: put__v15_filters_permissions_{filterId} parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The filter configuration content: application/json: schema: $ref: '#/components/schemas/FilterModelV15' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FilterIdResponseV15' delete: tags: - Filters API - Version 15 summary: Delete a Permission Filter operationId: delete__v15_filters_permissions_{filterId} parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '204': description: No content /v15/filters/reporting/{filterId}: get: tags: - Filters API - Version 15 summary: Get a Reporting Filter operationId: get__v15_filters_reporting_{filterId} parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FilterResponseV15' put: tags: - Filters API - Version 15 summary: Update a Reporting Filter operationId: put__v15_filters_reporting_{filterId} parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The filter configuration content: application/json: schema: $ref: '#/components/schemas/FilterModelV15' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FilterIdResponseV15' delete: tags: - Filters API - Version 15 summary: Delete a Reporting Filter operationId: delete__v15_filters_reporting_{filterId} parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '204': description: No content /v15/filters/permissions/{filterId}/targets: get: tags: - Filters API - Version 15 summary: Get the Targets of a Permission Filter operationId: get__v15_filters_permissions_{filterId}_targets parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/FilterTargetsResponseV15' put: tags: - Filters API - Version 15 summary: Set the Targets of a Permission Filter operationId: put__v15_filters_permissions_{filterId}_targets parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The entities to which the filter must be applied. content: application/json: schema: $ref: '#/components/schemas/FilterTargetsModelV15' required: true responses: '204': description: No content /v15/filters/monitoring/health: get: tags: - Filters API - Version 15 summary: Health Check for the Filter Service operationId: get__v15_filters_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/filters/status: get: tags: - Filters API - Version 15 summary: Get the Filter Service Status operationId: get__v15_filters_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/filters/permissions/{filterId}/users: get: tags: - Filters API - Version 15 summary: Get the Users of a Permission Filter operationId: get__v15_filters_permissions_{filterId}_users parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/UserResponseV15' put: tags: - Filters API - Version 15 summary: Set the Users of a Permission Filter operationId: put__v15_filters_permissions_{filterId}_users parameters: - name: filterId in: path description: The unique identifier of a filter. This id is generated by the server when creating a filter. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The users to set the permission on. content: application/json: schema: uniqueItems: true type: array items: type: string required: true responses: '204': description: No content /v15/groups: get: tags: - Groups API - Version 15 summary: Gets All Groups for Account. operationId: get__v15_groups parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GroupsResponseV15' /v15/groups/{groupId}/filters: get: tags: - Groups API - Version 15 summary: Gets the Data Level Filters That Apply to the Specified Group. operationId: get__v15_groups_{groupId}_filters parameters: - name: groupId in: path description: The unique identifier of a group. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FiltersResponseV14' put: tags: - Groups API - Version 15 summary: Set the Filters That Will Be Applied to the Specified Group's Query operationId: put__v15_groups_{groupId}_filters parameters: - name: groupId in: path description: The unique identifier of a group. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The filters that will be applied to the user. Must be a persisted filter ID content: application/json: schema: uniqueItems: true type: array items: $ref: '#/components/schemas/FilterValueModelV15' required: true responses: '204': description: No content /v15/groups/{groupId}: get: tags: - Groups API - Version 15 summary: Get a Group. operationId: get__v15_groups_{groupId} parameters: - name: groupId in: path description: The unique identifier of a group. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GroupResponseV15' /v15/groups/{groupId}/reports: get: tags: - Groups API - Version 15 summary: Gets the Reports That the Specified Group Can Access. operationId: get__v15_groups_{groupId}_reports parameters: - name: groupId in: path description: The unique identifier of a group. required: true schema: type: string - name: org in: query description: The unique identifier of a user. schema: type: string - name: includeConfig in: query description: Whether to include the detailed configuration of the report in the response. schema: type: boolean default: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReportsResponseV14' put: tags: - Groups API - Version 15 summary: Set Which Reports the Specified Group Can Access. operationId: put__v15_groups_{groupId}_reports parameters: - name: groupId in: path description: The unique identifier of a group. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The IDs of the reports the user can access content: application/json: schema: uniqueItems: true type: array items: type: string required: true responses: '204': description: No content /v15/groups/monitoring/health: get: tags: - Groups API - Version 15 summary: Health Check for the Groups Service operationId: get__v15_groups_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/groups/status: get: tags: - Groups API - Version 15 summary: Get the Groups Service Status operationId: get__v15_groups_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/metrics/{metricName}: get: tags: - Metrics API - Version 15 summary: Get a Metric operationId: get__v15_metrics_{metricName} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: metricName in: path description: metricName required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MetricResponseV15' /v15/metrics: get: tags: - Metrics API - Version 15 summary: Get All the Metrics operationId: get__v15_metrics parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MetricsResponseV15' /v15/metrics/monitoring/health: get: tags: - Metrics API - Version 15 summary: Health Check for the Metrics Service operationId: get__v15_metrics_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/metrics/status: get: tags: - Metrics API - Version 15 summary: Get the Metrics Service Status operationId: get__v15_metrics_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/admin/snowflake/readeraccounts: post: tags: - Reader Account API - Version 15 summary: Create a Reader Account operationId: post__v15_admin_snowflake_readeraccounts parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '201': description: Created content: application/json: schema: type: object properties: statusInfo: type: object properties: reasonPhrase: type: string statusCode: type: integer format: int32 family: type: string enum: - INFORMATIONAL - SUCCESSFUL - REDIRECTION - CLIENT_ERROR - SERVER_ERROR - OTHER mediaType: type: object properties: type: type: string subtype: type: string parameters: type: object additionalProperties: type: string wildcardType: type: boolean wildcardSubtype: type: boolean allowedMethods: uniqueItems: true type: array items: type: string cookies: type: object additionalProperties: type: object properties: name: type: string value: type: string version: type: integer format: int32 path: type: string domain: type: string comment: type: string maxAge: type: integer format: int32 expiry: type: string format: date-time secure: type: boolean httpOnly: type: boolean entity: type: object links: uniqueItems: true type: array items: type: object properties: rel: type: string rels: type: array items: type: string uriBuilder: type: object uri: type: string format: uri params: type: object additionalProperties: type: string title: type: string type: type: string status: type: integer format: int32 metadata: type: object additionalProperties: type: array items: type: object entityTag: type: object properties: value: type: string weak: type: boolean stringHeaders: type: object additionalProperties: type: array items: type: string length: type: integer format: int32 location: type: string format: uri language: type: object properties: language: type: string displayName: type: string country: type: string variant: type: string script: type: string unicodeLocaleAttributes: uniqueItems: true type: array items: type: string unicodeLocaleKeys: uniqueItems: true type: array items: type: string displayLanguage: type: string displayScript: type: string displayCountry: type: string displayVariant: type: string extensionKeys: uniqueItems: true type: array items: type: string iso3Language: type: string iso3Country: type: string date: type: string format: date-time lastModified: type: string format: date-time headers: type: object additionalProperties: type: array items: type: object /v15/admin/snowflake/users: get: tags: - Reader Account API - Version 15 summary: Get the Details for All Users from a Snowflake Reader Account operationId: get__v15_admin_snowflake_users parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/SnowflakeUserResponseV15' post: tags: - Reader Account API - Version 15 summary: Create a New User Within a Snowflake Reader Account operationId: post__v15_admin_snowflake_users parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: Snowflake user details. content: application/json: schema: $ref: '#/components/schemas/CreateSnowflakeUserModelV15' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/SnowflakeUserResponseV15' /v15/admin/snowflake/readeraccount: get: tags: - Reader Account API - Version 15 summary: Retrieve Snowflake Reader Account State operationId: get__v15_admin_snowflake_readeraccount parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SnowflakeReaderAccountStateResponseV15' delete: tags: - Reader Account API - Version 15 summary: Delete Snowflake Reader Account operationId: delete__v15_admin_snowflake_readeraccount parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '204': description: No content /v15/admin/snowflake/users/{snowflakeUser}: get: tags: - Reader Account API - Version 15 summary: Get the Details for a Specific User from a Snowflake Reader Account operationId: get__v15_admin_snowflake_users_{snowflakeUser} parameters: - name: snowflakeUser in: path description: The login name for the Snowflake user. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SnowflakeUserResponseV15' delete: tags: - Reader Account API - Version 15 summary: Delete a User from a Snowflake Reader Account operationId: delete__v15_admin_snowflake_users_{snowflakeUser} parameters: - name: snowflakeUser in: path description: The login name for the Snowflake user. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '204': description: No content /v15/admin/snowflake/creditusage: get: tags: - Reader Account API - Version 15 summary: Get the Amount of Compute Credits Used by a Snowflake Reader Account Within a Date Range operationId: get__v15_admin_snowflake_creditusage parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SnowflakeCreditUsageResponseV15' /v15/admin/snowflake/readeraccount/endpoint: get: tags: - Reader Account API - Version 15 summary: Retrieve Snowflake Reader Account Endpoint operationId: get__v15_admin_snowflake_readeraccount_endpoint parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SnowflakeReaderAccountEndpointResponseV15' /v15/admin/snowflake/networkpolicy: get: tags: - Reader Account API - Version 15 summary: Get the Details of the Active Network Policy for a Snowflake Reader Account operationId: get__v15_admin_snowflake_networkpolicy parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SnowflakeNetworkPolicyResponseV15' put: tags: - Reader Account API - Version 15 summary: Set the Details of the Active Network Policy for a Snowflake Reader Account operationId: put__v15_admin_snowflake_networkpolicy parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: Snowflake user details. content: application/json: schema: $ref: '#/components/schemas/SnowflakeNetworkPolicyModelV15' required: true responses: '204': description: No content /v15/admin/snowflake/users/{snowflakeUser}/passwordreset: post: tags: - Reader Account API - Version 15 summary: Reset a User's Password in a Snowflake Reader Account operationId: post__v15_admin_snowflake_users_{snowflakeUser}_passwordreset parameters: - name: snowflakeUser in: path description: The login name for the Snowflake user. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '204': description: No content /v15/admin/snowflake/users/{snowflakeUser}/expiration: put: tags: - Reader Account API - Version 15 summary: Change the Expiration Time of a Snowflake Reader Account User operationId: put__v15_admin_snowflake_users_{snowflakeUser}_expiration parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: snowflakeUser in: path description: The login name for the Snowflake user. required: true schema: type: string requestBody: description: Snowflake user details. content: application/json: schema: $ref: '#/components/schemas/UpdateSnowflakeUserExpirationRequestModelV15' required: true responses: '200': description: OK /v15/reports: get: tags: - Reports API - Version 15 summary: Get the Persisted Reports of One or All Types operationId: get__v15_reports parameters: - name: type in: query description: The type of the report. Must be either 'explorer' or 'dashboard'. schema: type: string enum: - DASHBOARD - EXPLORER - EXPLORER,DASHBOARD - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: includeConfig in: query description: Whether to include the detailed configuration of the report in the response. schema: type: boolean default: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReportsResponseV15' post: tags: - Reports API - Version 15 summary: Create a Report operationId: post__v15_reports parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The report configuration content: application/json: schema: $ref: '#/components/schemas/ReportModelV15' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ReportIdResponseV15' /v15/reports/{reportId}: get: tags: - Reports API - Version 15 summary: Get a Report operationId: get__v15_reports_{reportId} parameters: - name: reportId in: path description: The unique identifier of a report. This id is generated by the server when creating a report. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReportResponseV15' put: tags: - Reports API - Version 15 summary: Update a Report operationId: put__v15_reports_{reportId} parameters: - name: reportId in: path description: The unique identifier of a report. This id is generated by the server when creating a report. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The report configuration content: application/json: schema: $ref: '#/components/schemas/ReportModelV15' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReportIdResponseV15' delete: tags: - Reports API - Version 15 summary: Delete a Report operationId: delete__v15_reports_{reportId} parameters: - name: reportId in: path description: The unique identifier of a report. This id is generated by the server when creating a report. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '204': description: No content /v15/reports/{reportId}/access: get: tags: - Reports API - Version 15 summary: Get the Users and Groups Who Can View a Report operationId: get__v15_reports_{reportId}_access parameters: - name: reportId in: path description: The unique identifier of a report. This id is generated by the server when creating a report. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReportAccessResponseV15' put: tags: - Reports API - Version 15 summary: Set the Users and Groups Who Are Allowed to View a Report operationId: put__v15_reports_{reportId}_access parameters: - name: reportId in: path description: The unique identifier of a report. This id is generated by the server when creating a report. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The entities that are allowed to view the report. content: application/json: schema: $ref: '#/components/schemas/ReportAccessModelV15' required: true responses: '204': description: No content /v15/reports/monitoring/health: get: tags: - Reports API - Version 15 summary: Health Check for the Reports Service operationId: get__v15_reports_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/reports/status: get: tags: - Reports API - Version 15 summary: Get the Reports Service Status operationId: get__v15_reports_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/reports/templates/{templateId}: get: tags: - Reports API - Version 15 summary: Get a Report Template operationId: get__v15_reports_templates_{templateId} parameters: - name: templateId in: path description: The unique identifier of a template. required: true schema: type: string - name: includeMetadata in: query description: Whether to include metadata about the report template. schema: type: boolean - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/TemplateResponseV15' /v15/reports/templates: get: tags: - Reports API - Version 15 summary: Get Metadata About Available Report Templates operationId: get__v15_reports_templates parameters: - name: type in: query description: The type of the report. Must be either 'explorer' or 'dashboard'. required: true schema: type: string enum: - DASHBOARD - EXPLORER default: DASHBOARD - name: includeMetadata in: query description: Whether to include metadata about the report template. schema: type: boolean - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/TemplateMetadataResponseV15' /v15/reports/{reportId}/users: get: tags: - Reports API - Version 15 summary: Get the Users Who Can View a Report operationId: get__v15_reports_{reportId}_users parameters: - name: reportId in: path description: The unique identifier of a report. This id is generated by the server when creating a report. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReportUsersResponseV15' put: tags: - Reports API - Version 15 summary: Set the Users Who Are Allowed to View a Report operationId: put__v15_reports_{reportId}_users parameters: - name: reportId in: path description: The unique identifier of a report. This id is generated by the server when creating a report. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The IDs of the allowed users. content: application/json: schema: uniqueItems: true type: array items: type: string required: true responses: '204': description: No content /v15/admin/snowflake/securedatasharing/accounts: get: tags: - Secure Data Sharing API - Version 15 summary: Retrieve Snowflake Accounts Currently Associated in Secure Data Sharing operationId: get__v15_admin_snowflake_securedatasharing_accounts parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/SnowflakeDataSharingAccountResponseV15' post: tags: - Secure Data Sharing API - Version 15 summary: Add a Snowflake Account to Secure Data Sharing operationId: post__v15_admin_snowflake_securedatasharing_accounts parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The Snowflake account to which data should be shared. content: application/json: schema: $ref: '#/components/schemas/SnowflakeDataSharingAccountModelV15' responses: '204': description: No content delete: tags: - Secure Data Sharing API - Version 15 summary: Removes a Snowflake Account from Secure Data Sharing operationId: delete__v15_admin_snowflake_securedatasharing_accounts parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: accountLocator in: query description: The Snowflake account locator. required: true schema: type: string - name: snowflakeRegion in: query description: The Snowflake region. required: true schema: type: string responses: '204': description: No content /v15/admin/snowflake/securedatasharing/regions: get: tags: - Secure Data Sharing API - Version 15 summary: Retrieve Allowed Snowflake Regions for Secure Data Sharing operationId: get__v15_admin_snowflake_securedatasharing_regions parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SnowflakeDataSharingRegionsResponseV15' /v15/stats/query/{queryId}: delete: tags: - Statistics API - Version 15 summary: Cancel the Execution of a Query description: This is a best effort; there is no guarantee that the query will be cancelled. If the query is cancelled, the sender of the now cancelled query will receive a 409 Conflict. operationId: delete__v15_stats_query_{queryId} parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '202': description: Accepted /v15/stats/combinedData: get: tags: - Statistics API - Version 15 summary: Get Metrics Combined with Dimensions for a Date Range description: There is one value of each metric for every possible dimension combination. operationId: get__v15_stats_combinedData parameters: - name: m in: query description: The metrics to fetch. required: true schema: type: array items: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string default: Z - name: d in: query description: The dimensions to fetch. required: true schema: type: array items: type: string - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fm in: query description: The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: s in: query description: The field to order the results by. It must be a dimension, metric or custom dimension that was specified in the 'm' or the 'd' parameter. schema: type: string - name: p in: query description: The response's page to access, starting at 1. schema: type: integer format: int32 - name: n in: query description: The number of results to include in a page. schema: type: integer format: int32 - name: asc in: query description: Whether to sort by ascending order. schema: type: boolean default: true - name: includeMetadata in: query description: Whether to include metadata regarding the results (total count and unique counts, if applicable). schema: type: boolean default: true - name: format in: query description: The format of the response. Default is JSON. schema: type: string enum: - JSON - CSV - JSON,CSV default: JSON - name: bindOnLastSearch in: query description: bindOnLastSearch schema: type: boolean default: true - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CombinedDataResponseV15' text/csv: schema: $ref: '#/components/schemas/CombinedDataResponseV15' /v15/stats/trends: get: tags: - Statistics API - Version 15 summary: Get Trends of a Metric Combined with Dimensions for a Date Range description: There is one value of each metric for every possible dimension combination. operationId: get__v15_stats_trends parameters: - name: m in: query description: The metrics to fetch. required: true schema: type: array items: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: previousFrom in: query description: The beginning date of the previous date range, when reporting trends. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'. If not specified, it will be the 'from' date minus the duration of the 'from'-'to' date range. schema: type: string - name: previousTo in: query description: The end date of the previous date range, when reporting trends. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'. If not specified, it will be the 'to' date minus the duration of the 'from'-'to' date range. schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string default: Z - name: d in: query description: The dimensions to fetch. required: true schema: type: array items: type: string - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fm in: query description: The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: s in: query description: The field to order the results by. It must be a dimension, metric or custom dimension that was specified in the 'm' or the 'd' parameter. schema: type: string - name: p in: query description: The response's page to access, starting at 1. schema: type: integer format: int32 - name: n in: query description: The number of results to include in a page. schema: type: integer format: int32 - name: asc in: query description: Whether to sort by ascending order. schema: type: boolean default: true - name: includeMetadata in: query description: Whether to include metadata regarding the results (total count and unique counts, if applicable). schema: type: boolean default: true - name: format in: query description: The format of the response. Default is JSON. schema: type: string enum: - JSON - CSV - JSON,CSV default: JSON - name: bindOnLastSearch in: query description: bindOnLastSearch schema: type: boolean default: true - name: t in: query description: The trends to caculate. required: true schema: type: array items: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CombinedDataResponseV15' text/csv: schema: $ref: '#/components/schemas/CombinedDataResponseV15' /v15/stats/globalData: get: tags: - Statistics API - Version 15 summary: Get Global Data for Each Metric for a Date Range description: Global data contain the total, the daily peak and the daily average. operationId: get__v15_stats_globalData parameters: - name: m in: query description: The metrics to fetch. required: true schema: type: array items: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string default: Z - name: d in: query description: The dimensions to fetch. Required when the Activity metric is requested as it has to be based on a dimension. schema: type: array items: type: string - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: i in: query description: The interval on which data will be grouped. Default value is DAY. schema: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - MINUTE,HOUR,DAY,WEEK,MONTH default: DAY - name: bindOnLastSearch in: query description: bindOnLastSearch schema: type: boolean default: true - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GlobalAggregatedDataResponseV15' /v15/stats/graphDataPoints: get: tags: - Statistics API - Version 15 summary: Get Graph Data Points for the Metrics for a Date Range description: There is one data point per interval per metric. The interval can be specified with the 'i' query parameter. operationId: get__v15_stats_graphDataPoints parameters: - name: m in: query description: The metrics to fetch. required: true schema: type: array items: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string default: Z - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: i in: query description: The interval on which data will be grouped. Default value is DAY. schema: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - MINUTE,HOUR,DAY,WEEK,MONTH default: DAY - name: bindOnLastSearch in: query description: bindOnLastSearch schema: type: boolean default: true - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GraphAggregatedDataResponseV15' /v15/stats/monitoring/health: get: tags: - Statistics API - Version 15 summary: Health Check for the Statistics Service operationId: get__v15_stats_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/stats/status: get: tags: - Statistics API - Version 15 summary: Get the Statistics Service Status operationId: get__v15_stats_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/stats/visitsGraphDataPoints: get: tags: - Statistics API - Version 15 summary: Get Graph Data Points for Visit Based Metrics for a Date Range description: There is one data point per interval per metric. The interval can be specified with the 'i' query parameter. operationId: get__v15_stats_visitsGraphDataPoints parameters: - name: m in: query description: The metrics to fetch. required: true schema: type: array items: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string default: Z - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: hideEventFilters in: query description: Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fn in: query description: The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: i in: query description: The interval on which data will be grouped. Default value is DAY. schema: type: string enum: - MINUTE - HOUR - DAY - WEEK - MONTH - MINUTE,HOUR,DAY,WEEK,MONTH default: DAY - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GraphAggregatedDataResponseV15' /v15/stats/visitsMetrics: get: tags: - Statistics API - Version 15 summary: Get the Metrics Based on the Visits Matching the Specified Criteria operationId: get__v15_stats_visitsMetrics parameters: - name: m in: query description: The metrics to fetch. required: true schema: type: array items: type: string - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string default: Z - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: hideEventFilters in: query description: Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fn in: query description: The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GlobalAggregatedDataResponseV15' /v15/stats/visits: get: tags: - Statistics API - Version 15 summary: Get the Details of the Visits Matching the Specified Criteria operationId: get__v15_stats_visits parameters: - name: from in: query description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: to in: query description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' required: true schema: type: string - name: tz in: query description: Timezone used for calculations. schema: type: string default: Z - name: d in: query description: The dimensions to fetch. schema: type: array items: type: string - name: f in: query description: The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: hideEventFilters in: query description: Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: fn in: query description: The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator. schema: type: array items: type: string - name: s in: query description: The field to order the results by. It must be a dimension, metric or custom dimension that was specified in the 'm' or the 'd' parameter. schema: type: string default: eventDatetime - name: p in: query description: The response's page to access, starting at 1. schema: type: integer format: int32 - name: n in: query description: The number of results to include in a page. schema: type: integer format: int32 - name: asc in: query description: Whether to sort by ascending order. schema: type: boolean default: false - name: includeMetadata in: query description: Whether to include metadata regarding the results (total count and unique counts, if applicable). schema: type: boolean default: true - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VisitsStatisticsResponseV15' post: tags: - Statistics API - Version 15 summary: Force a Visit View Update description: Global data contain the total, the daily peak and the daily average. operationId: post__v15_stats_visits parameters: - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '204': description: No content /v15/users/{userId}/filters: get: tags: - Users API - Version 15 summary: Get the Data Level Filters That Apply to a User operationId: get__v15_users_{userId}_filters parameters: - name: userId in: path description: The unique identifier of a user. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: includeGroups in: query description: Whether to include the values inherited from a user's groups in the response. schema: type: boolean default: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FiltersResponseV15' put: tags: - Users API - Version 15 summary: Set the Filters That Will Be Applied to a User Query operationId: put__v15_users_{userId}_filters parameters: - name: userId in: path description: The unique identifier of a user. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string requestBody: description: The filters that will be applied to the user. Must be a persisted filter ID content: application/json: schema: uniqueItems: true type: array items: $ref: '#/components/schemas/FilterValueModelV15' required: true responses: '204': description: No content /v15/users/{userId}/reports: get: tags: - Users API - Version 15 summary: Get the Reports That a User Can Access operationId: get__v15_users_{userId}_reports parameters: - name: userId in: path description: The unique identifier of a user. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: includeConfig in: query description: Whether to include the detailed configuration of the report in the response. schema: type: boolean default: true - name: includeGroups in: query description: Whether to include the values inherited from a user's groups in the response. schema: type: boolean default: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ReportsResponseV15' put: tags: - Users API - Version 15 summary: Set Which Reports a User Can Access operationId: put__v15_users_{userId}_reports parameters: - name: userId in: path description: The unique identifier of a user. required: true schema: type: string - name: org in: query description: The unique identifier of a user. schema: type: string requestBody: description: The IDs of the reports the user can access content: application/json: schema: uniqueItems: true type: array items: type: string required: true responses: '204': description: No content /v15/users/monitoring/health: get: tags: - Users API - Version 15 summary: Health Check for the Users Service operationId: get__v15_users_monitoring_health responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/users/status: get: tags: - Users API - Version 15 summary: Get the Users Service Status operationId: get__v15_users_status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StatusResponse' /v15/users/{userId}: get: tags: - Users API - Version 15 summary: Get a User operationId: get__v15_users_{userId} parameters: - name: userId in: path description: The unique identifier of a user. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserResponseV15' /v15/users/{userId}/alldata: delete: tags: - User Statistics API - Version 15 summary: Delete the User Data operationId: delete__v15_users_{userId}_alldata parameters: - name: userId in: path description: The unique identifier of a user. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/UserDataDeleteResponseV15' /v15/users/{userId}/overview: get: tags: - User Statistics API - Version 15 summary: Get the Stats of a User operationId: get__v15_users_{userId}_overview parameters: - name: userId in: path description: The unique identifier of a user. required: true schema: type: string - name: org in: query description: The name of the organization (Coveo Cloud V2 only) schema: type: string - name: cached in: query description: cached schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserStatisticsResponseV15' components: schemas: DimensionResponseV14: required: - apiNames - custom - displayName - eventTypes - returnName - status - type type: object properties: type: type: string description: The type of the dimension enum: - TEXT - NUMBER - SHORT - BOOLEAN - DATE - DATETIME displayName: type: string description: The display name of the dimension apiNames: uniqueItems: true type: array description: A collection of possible names to use when querying the statistics service with this dimension items: type: string description: A collection of possible names to use when querying the statistics service with this dimension returnName: type: string description: The name of the dimension when returned by the statistics service custom: type: boolean description: A flag indicating if the dimension is a custom dimension availableInVisit: type: boolean description: Whether the dimension is available in a visit's statistics. eventTypes: uniqueItems: true type: array description: Indicates the type of events that this dimension can be attached to. items: type: string description: Indicates the type of events that this dimension can be attached to. status: type: string description: The status of the dimension enum: - AVAILABLE - UPDATING description: The details of a dimension CustomDimensionModelV15: required: - displayName - type type: object properties: type: type: string description: The type of the dimension enum: - TEXT - NUMBER - SHORT - BOOLEAN - DATE - DATETIME - TEXT - NUMBER - SHORT - BOOLEAN - DATE - DATETIME displayName: type: string description: The display name of the dimension. Should be human readable path: type: array description: 'Strings that correspond to the path that must be followed to fetch the desired value of the dimension in the custom_datas map. For example, let''s consider the following custom_datas map: ''{"a":{"b":"c"}}''. To select the value "c", the path would need to contain the elements "a" and "b".' items: type: string description: Additional required information to create a custom dimension CustomDimensionModelV14: required: - displayName - type type: object properties: type: type: string description: The type of the dimension enum: - TEXT - NUMBER - SHORT - BOOLEAN - DATE - DATETIME - TEXT - NUMBER - SHORT - BOOLEAN - DATE - DATETIME displayName: type: string description: The display name of the dimension Should be human readable description: Additional required information to create a custom dimension CustomDimensionSuggestionResponseV14: type: object properties: eventName: type: string description: The event type of the custom dimension apiName: type: string description: The api name of the custom dimension values: uniqueItems: true type: array description: The existing values for the custom dimension items: type: string description: The existing values for the custom dimension description: Information regarding the custom dimension CustomDimensionSuggestionsResponseV14: required: - suggestions type: object properties: suggestions: type: array description: Information regarding the custom dimension items: $ref: '#/components/schemas/CustomDimensionSuggestionResponseV14' description: Suggestions of custom dimensions that could be created StatusResponse: type: object description: Service's status information DimensionValuesResponseV14: type: object properties: values: type: array description: The values for this dimension items: type: object additionalProperties: type: object description: The values for this dimension description: The values for this dimension description: The values for this dimension ExportEstimateResponseV14: required: - estimates type: object properties: estimates: type: object additionalProperties: type: integer description: The estimated number of rows by event format: int64 description: The estimated number of rows by event description: Export's number of row estimate ExportResponseV14: required: - author - description - filters - from - id - size - startDate - status - to type: object properties: id: type: string description: The export's unique identifier author: type: string description: The user who created this export downloadLink: type: string description: The export download link. Only appears when export is ready format: url startDate: type: integer description: The date at which this export was started. Epoch time format in milliseconds (POSIX time or UNIX Epoch time) format: int64 from: type: integer description: The beginning date of the date range. Epoch time format in milliseconds (POSIX time or UNIX Epoch time) format: int64 to: type: integer description: The end date of the date range. Epoch time format in milliseconds (POSIX time or UNIX Epoch time) format: int64 filters: type: object additionalProperties: type: string description: The filters that will be applied to the export description: The filters that will be applied to the export description: type: string description: A description of this export size: type: integer description: In bytes format: int64 status: type: string description: The status of this export enum: - AVAILABLE - PENDING - FAILED - EXPIRED description: Export's information FilterIdResponseV14: type: object properties: id: type: string description: A filter id. description: A filter id. FilterModelV14: required: - displayName - value type: object properties: displayName: type: string description: The display name of the filter. value: type: string description: The actual value of the filter. description: A filter. FilterResponseV14: type: object properties: id: type: string description: The filter id. displayName: type: string description: The filter display name. account: type: string description: The filter account. type: type: string description: The filter type. Can be 'permissions' or 'reporting'. value: type: string description: The actual filter. description: A filter. FiltersResponseV14: type: object properties: filters: type: array description: The filters that are applied to the user items: $ref: '#/components/schemas/FilterResponseV14' description: The filters that are applied to the user UserResponseV14: type: object properties: userId: type: string description: The user id. account: type: string description: The user account. filters: uniqueItems: true type: array description: The filters that are applied to the user items: type: string description: The filters that are applied to the user reports: uniqueItems: true type: array description: The reports the user can view. items: type: string description: The reports the user can view. description: A user. MetricResponseV14: type: object properties: metricName: type: string description: The metric name. Also acts as a unique identifier. displayName: type: string description: A name that can be used for displaying the metric in UI. type: type: string description: The type of the metric value. higherIsBetter: type: boolean description: Whether a higher value is better. For example, higher clicks is better, higher average click rank is bad. A null value indicates that it depends on the context. percentage: type: boolean description: Whether the metric must be interpreted as a percentage. eventTypes: uniqueItems: true type: array description: The list of event types that might be used to calculate this metric. items: type: string description: The list of event types that might be used to calculate this metric. description: The details of a metric. MetricsResponseV14: type: object properties: metricResponses: type: array description: A collection of metrics. items: $ref: '#/components/schemas/MetricResponseV14' description: A collection of metrics. ReportIdResponseV14: type: object properties: id: type: string description: The report id. description: A report id. ReportModelV14: required: - allAnalyticsViewer - configuration - displayName - type type: object properties: displayName: type: string description: The display name of the report. type: type: string description: The type of the report. Must be either 'explorer' or 'dashboard'. enum: - DASHBOARD - EXPLORER allAnalyticsViewer: type: boolean description: Whether the report should be available to all analytics viewer. configuration: type: object additionalProperties: type: object description: The configuration of the report. Must be a json. description: The configuration of the report. Must be a json. filters: uniqueItems: true type: array description: The ids of the persisted filters associated with the report. items: type: string description: The ids of the persisted filters associated with the report. description: The configuration of a report. ReportResponseV14: type: object properties: id: type: string description: The report id. account: type: string description: The report account. displayName: type: string description: The report display name. type: type: string description: The report type. configuration: type: object additionalProperties: type: object description: The report configuration. description: The report configuration. allAnalyticsViewer: type: boolean description: Whether the report is available to all analytics viewer. filters: uniqueItems: true type: array description: List of associated filters. items: type: string description: List of associated filters. description: A report configuration. ReportsResponseV14: type: object properties: reports: uniqueItems: true type: array description: The reports the user can view. items: $ref: '#/components/schemas/ReportResponseV14' description: The reports the user can view. ReportUsersResponseV14: type: object properties: access: type: string description: The access type of the report. Can be PUBLIC or PRIVATE. enum: - PUBLIC - PRIVATE - PUBLIC - PRIVATE allowedUsers: type: array description: The users allowed to access the specified report. items: $ref: '#/components/schemas/UserResponseV14' description: The users allowed to access the specified report. CombinedDataResponseV14: required: - combinations type: object properties: combinations: type: array description: The metrics/dimensions combinations items: type: object additionalProperties: type: object description: The metrics/dimensions combinations description: The metrics/dimensions combinations uniqueCounts: type: object additionalProperties: type: object description: The unique counts for the different values of all specified dimensions description: The unique counts for the different values of all specified dimensions totalNumberOfResults: type: integer description: The total number of combinations available format: int32 description: The values of the metrics combined by dimensions GlobalAggregatedDataResponseV14: required: - globalDatas type: object properties: globalDatas: type: object additionalProperties: type: object additionalProperties: type: number description: The global values by metrics. Usually a unique count, a daily count or daily average description: The global values by metrics. Usually a unique count, a daily count or daily average description: The global values by metrics. Usually a unique count, a daily count or daily average description: The global aggregated values by metrics DataPoint: required: - datas - dateTime type: object properties: dateTime: type: string description: The moment in time that this point represents format: date-time datas: type: object additionalProperties: type: number description: The metric values description: The metric values description: A collection of data points GraphAggregatedDataResponseV14: required: - dataPoints - totals type: object properties: dataPoints: type: array description: A collection of data points items: $ref: '#/components/schemas/DataPoint' totals: type: object additionalProperties: type: number description: The totals for the requested metrics. description: The totals for the requested metrics. stats: type: object additionalProperties: $ref: '#/components/schemas/SummaryStatisticsPojo' description: The sum, average, max and min for the requested metrics. description: The data points to be used in a graph, aggregated by the specified time interval. SummaryStatisticsPojo: type: object properties: {} description: The sum, average, max and min for the requested metrics. EventPojo: type: object properties: {} description: The visit's events VisitStatisticsResponseV15: required: - visitId type: object properties: visitId: type: string description: The visit id events: type: array description: The visit's events items: $ref: '#/components/schemas/EventPojo' numberOfEvents: type: integer description: The number of events format: int32 description: The visit matching the specified criteria VisitsStatisticsResponseV14: required: - visits type: object properties: visits: type: array description: The visits matching the specified criteria items: $ref: '#/components/schemas/VisitStatisticsResponseV15' totalNumberOfVisits: type: integer description: The total number of visits matching format: int32 description: The visits matching the specified criteria FilterValueModelV14: required: - id - value type: object properties: value: type: string description: The actual value of the filter. id: type: boolean description: Whether the value is a persisted filter ID or a filter value description: A filter value. AccountResponseV15: type: object properties: name: type: string description: The name of the account enabled: type: boolean description: Whether the account is enabled in Usage Analytics status: type: string description: The status of the account. Can be CREATING, AVAILABLE or DELETING enum: - AVAILABLE - CREATING - DELETING - AVAILABLE - CREATING - DELETING internalEventIps: uniqueItems: true type: array description: A set of IP addresses or CIDR blocks identifying the origin of events qualified as 'internal' items: type: string description: A set of IP addresses or CIDR blocks identifying the origin of events qualified as 'internal' useStrictFieldValidation: type: boolean description: 'Deprecated. Will be removed in April 2025. Whether to use the strict field validation on incoming events.' description: The response to get and edit account operations AccountInfoModelV15: type: object properties: internalEventIps: uniqueItems: true type: array description: A set of IP addresses or CIDR blocks from which events will be considered internal. items: type: string description: A set of IP addresses or CIDR blocks from which events will be considered internal. useStrictFieldValidation: type: boolean description: 'Deprecated. Will be removed in April 2025. Whether to use the strict field validation on incoming events.' description: Account informations StrictValidationTestResponseV15: required: - dimensionName - validationTestResults type: object properties: dimensionName: type: string description: The name of the dimension validationTestResults: type: array description: The rejected values items: type: object additionalProperties: type: object description: The rejected values description: The rejected values description: Values that would be excluded by the strict validation for the specified dimension GetEventPayloadResponseV15: type: object properties: eventId: type: string description: The ID of the event. timestamp: type: string description: The timestamp of the event, in ISO8601 format. eventPayload: type: object description: The raw payload of the event. description: An event's payload. EventProblemsListItemV15: type: object properties: eventType: type: string description: The type of the event. trackingId: type: string description: The tracking ID of the event. searchHub: type: string description: The search hub of the event. failedEvents: type: integer description: The total number of events that are failing with the specified problems. totalEvents: type: integer description: The total number of events for that event type, tracking ID and search hub combination. validationErrors: type: array description: The validation errors of the event items: $ref: '#/components/schemas/ValidationErrorV15' sampleEvents: type: array description: A list of sample events ids items: type: string description: A list of sample events ids sampleEventsTimestamps: type: array description: A list of timestamps associated with the sampleEvents items: type: string description: A list of timestamps associated with the sampleEvents description: An entry in a list of events problems. EventProblemsResponseV15: required: - pagination type: object properties: problems: type: array description: The problems. items: $ref: '#/components/schemas/EventProblemsListItemV15' description: A list of events problems. PaginationV15: type: object properties: page: type: integer description: The current page number. 0-based. format: int32 perPage: type: integer description: The number of items per page. format: int32 totalPages: type: integer description: The total number of pages. format: int32 totalItems: type: integer description: The total number of items. format: int64 description: Information about pagination for this request. ValidationErrorV15: required: - code - message - path type: object properties: code: type: string description: The error code. path: type: string description: The path of the parameter causing the error. message: type: string description: A description of the error. description: A validation error found on an event. FailedInstancesListItemV15: type: object properties: timestamp: type: string description: The failed instance's timestamp, in ISO 8601 format. eventId: type: string description: The failed instance's eventId. visitId: type: string description: The failed instance's visitId. clientId: type: string description: The failed instance's clientId scope: type: string description: The scope of the failed instance. enum: - EVENT - VISIT description: A failed instance. FailedInstancesResponseV15: type: object properties: failedInstances: type: array description: The failed instances. items: $ref: '#/components/schemas/FailedInstancesListItemV15' description: A list of failed instances. GroupDetailListItemV15: type: object properties: id: type: string description: The criterion's identifier. category: type: string description: The criterion's category. severity: type: string description: The criterion's severity. enum: - LOW - MEDIUM - HIGH - CRITICAL score: type: number description: The score for the criterion. scope: type: string description: The scope of the criterion. scopeValue: type: string description: The value associated with that criterion's scope. totalValidations: type: integer description: The total number of validations performed. failedValidations: type: integer description: The number of validations that failed. description: A list of groups. GroupDetailResponseV15: type: object properties: criteria: type: array description: The criteria. items: $ref: '#/components/schemas/GroupDetailListItemV15' description: A list of criteria detail information. GroupListingListItemV15: type: object properties: group: type: string description: The group's name. score: type: number description: The overall score. totalValidations: type: integer description: The total number of validations performed. failedValidations: type: integer description: The number of validations that failed. severityBreakdown: type: object additionalProperties: type: integer description: A breakdown of the proportion of failures associated with different rule severities. description: A breakdown of the proportion of failures associated with different rule severities. description: An entry in a list of groups. GroupListingResponseV15: type: object properties: groups: type: array description: The groups. items: $ref: '#/components/schemas/GroupListingListItemV15' description: A list of groups. OverviewResponseV15: type: object properties: score: type: number description: The overall score. totalValidations: type: integer description: The total number of validations performed. failedValidations: type: integer description: The number of validations that failed. severityBreakdown: type: object additionalProperties: type: integer description: A breakdown of the proportion of failures associated with different rule severities. description: A breakdown of the proportion of failures associated with different rule severities. description: An overview of the data health of an organization. ListEventsListItemV15: required: - clientId - eventId - searchHub - source - timestamp - trackingId - type - visitId type: object properties: source: type: string description: The source of the event. type: type: string description: The type of the event. searchHub: type: string description: The search hub of the event. trackingId: type: string description: The tracking ID of the event. timestamp: type: string description: The timestamp of the event, in ISO8601 format. visitId: type: string description: The visitId of the event. clientId: type: string description: The clientId of the event. eventId: type: string description: The id of the event. validationErrors: type: array description: The validation errors of the event items: $ref: '#/components/schemas/ValidationErrorV15' description: An entry in a list of events. ListEventsResponseV15: type: object properties: events: type: array description: The events. items: $ref: '#/components/schemas/ListEventsListItemV15' description: A list of events. FacetValueV15: required: - count - value type: object properties: value: type: object description: A facet value. count: type: integer description: The count for this facet value. format: int64 description: A facet value and the associated count. ListFacetValuesResponseV15: required: - values type: object properties: values: type: array description: The values for this facet items: $ref: '#/components/schemas/FacetValueV15' description: The values available for the facet DimensionResponseV15: required: - apiNames - custom - displayName - eventTypes - returnName - status - type type: object properties: type: type: string description: The type of the dimension enum: - TEXT - NUMBER - SHORT - BOOLEAN - DATE - DATETIME displayName: type: string description: The display name of the dimension apiNames: uniqueItems: true type: array description: A collection of possible names to use when querying the statistics service with this dimension items: type: string description: A collection of possible names to use when querying the statistics service with this dimension returnName: type: string description: The name of the dimension when returned by the statistics service custom: type: boolean description: A flag indicating if the dimension is a custom dimension availableInVisit: type: boolean description: Whether the dimension is available in a visit's statistics. eventTypes: uniqueItems: true type: array description: Indicates the type of events that this dimension can be attached to. items: type: string description: Indicates the type of events that this dimension can be attached to. status: type: string description: The status of the dimension enum: - AVAILABLE - UPDATING path: type: array description: The path in the custom_datas map corresponding to this dimension. For custom dimensions only. items: type: string description: The path in the custom_datas map corresponding to this dimension. For custom dimensions only. description: The details of a dimension CustomDimensionSuggestionResponseV15: type: object properties: eventName: type: string description: The event type of the custom dimension apiName: type: string description: The api name of the custom dimension values: uniqueItems: true type: array description: The existing values for the custom dimension items: type: string description: The existing values for the custom dimension description: Information regarding the custom dimension CustomDimensionSuggestionsResponseV15: required: - suggestions type: object properties: suggestions: type: array description: Information regarding the custom dimension items: $ref: '#/components/schemas/CustomDimensionSuggestionResponseV15' description: Suggestions of custom dimensions that could be created DimensionValuesResponseV15: type: object properties: values: type: array description: The values for this dimension items: type: object additionalProperties: type: object description: The values for this dimension description: The values for this dimension description: The values for this dimension ExceptionInfo: type: object properties: {} description: Information about errors regarding the schedule, if any. ExportScheduleResponseV15: required: - author - description - filters - frequency - id - timezone type: object properties: id: type: string description: The export schedule's unique identifier author: type: string description: The author of the export schedule frequency: type: string description: The execution frequency of the export schedule enum: - DAILY - MONTHLY - WEEKLY dayOfWeek: type: string description: The day of the week on which the export is executed (for weekly exports) enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY timezone: type: string description: The timezone of the export schedule filters: type: object additionalProperties: type: string description: The filters that will be applied to the exports created by the schedule description: The filters that will be applied to the exports created by the schedule dimensions: type: array description: The requested dimensions for the schedule's exports, if specified items: type: string description: The requested dimensions for the schedule's exports, if specified tables: uniqueItems: true type: array description: The requested tables for the schedule's exports, if specified items: type: string description: The requested tables for the schedule's exports, if specified description: type: string description: A description of this export schedule usingDisplayNames: type: boolean description: Whether the generated export headers will be using display names. notificationsEmails: uniqueItems: true type: array description: The email addresses of the users that will be notified when an export is ready. items: type: string description: The email addresses of the users that will be notified when an export is ready. description: Information about the export schedule ExportScheduleModelV15: required: - frequency - timezone type: object properties: frequency: type: string description: The execution frequency of the export schedule enum: - DAILY - MONTHLY - WEEKLY dayOfWeek: type: string description: The day of the week on which the export is executed (for weekly exports) enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY timezone: type: string description: The timezone of the export schedule dimensions: type: array description: The requested dimensions for the schedule's exports, if specified items: type: string description: The requested dimensions for the schedule's exports, if specified commonFilters: type: array description: The filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator. items: type: string description: The filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator. searchesFilters: type: array description: The filter that will be applied to the search and click events dimensions. Multiple filter parameters are joined with the AND operator. items: type: string description: The filter that will be applied to the search and click events dimensions. Multiple filter parameters are joined with the AND operator. customEventsFilters: type: array description: The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator. items: type: string description: The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator. description: type: string description: A description of this export schedule tables: type: array description: The requested tables for the schedule's exports, if specified items: type: string description: The requested tables for the schedule's exports, if specified enum: - SEARCHES - CLICKS - CUSTOM_EVENTS - KEYWORDS - GROUPS - ALL_EVENTS exportFormat: type: string description: The format of the generated CSV files. enum: - EXCEL - NO_NEWLINE usingDisplayNames: type: boolean description: Whether the generated export headers will be using display names. notificationsEmails: uniqueItems: true type: array description: The email addresses of the users that will be notified when an export is ready. items: type: string description: The email addresses of the users that will be notified when an export is ready. description: An export schedule. ExportEstimateResponseV15: required: - estimates type: object properties: estimates: type: object additionalProperties: type: integer description: The estimated number of rows by event format: int64 description: The estimated number of rows by event description: Export's number of row estimate ExportResponseV15: required: - author - description - downloadable - filters - from - id - size - startDate - status - to type: object properties: id: type: string description: The export's unique identifier author: type: string description: The user who created this export downloadLink: type: string description: The export download link. Only appears when export is ready format: url startDate: type: integer description: The date at which this export was started. Epoch time format in milliseconds (POSIX time or UNIX Epoch time) format: int64 from: type: integer description: The beginning date of the date range. Epoch time format in milliseconds (POSIX time or UNIX Epoch time) format: int64 to: type: integer description: The end date of the date range. Epoch time format in milliseconds (POSIX time or UNIX Epoch time) format: int64 filters: type: object additionalProperties: type: string description: The filters that will be applied to the export description: The filters that will be applied to the export description: type: string description: A description of this export size: type: integer description: In bytes format: int64 status: type: string description: The status of this export enum: - AVAILABLE - PENDING - FAILED - EXPIRED tables: uniqueItems: true type: array description: The requested tables for this export, if specified items: type: string description: The requested tables for this export, if specified downloadable: type: boolean description: Whether the export is downloadable when available dimensions: uniqueItems: true type: array description: The requested dimensions for this export, if specified items: type: string description: The requested dimensions for this export, if specified replayable: type: boolean description: Whether the export can be replayed. usingDisplayNames: type: boolean description: Whether the export header is using the display names. scheduleId: type: string description: The id of the schedule an export was generated by (if scheduled export) description: Export's information ExportVisitsModelV15: type: object properties: from: type: string description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' to: type: string description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' inclusionFilters: type: array description: The filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator. items: type: string description: The filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator. hideEventFilters: type: array description: Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator. items: type: string description: Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator. exclusionFilters: type: array description: The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator. items: type: string description: The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator. filename: type: string description: A file name for the export. Can only contain US-ASCII characters. If none is supplied it will be set to the export's id. description: type: string description: Export's description. dimensions: type: array description: The dimensions that will be exported. If not provided, all dimensions will be exported. items: type: string description: The dimensions that will be exported. If not provided, all dimensions will be exported. exportFormat: type: string description: The format of the generated CSV files. enum: - EXCEL - NO_NEWLINE default: EXCEL useDisplayNames: type: boolean description: Whether to use the display names in the export's header. If false, the api names will be used. default: false ordered: type: boolean description: Whether to order the rows by datetime in the export. If the number of rows exported is to great, this parameter will be ignored and data will be unsorted. default: true description: An export of visits. ExportModelV15: type: object properties: from: type: string description: The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' to: type: string description: The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ' commonFilters: type: array description: The filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator. items: type: string description: The filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator. searchesFilters: type: array description: The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator. items: type: string description: The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator. customEventsFilters: type: array description: The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator. items: type: string description: The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator. filename: type: string description: A file name for the export. Can only contain US-ASCII characters. If none is supplied it will be set to the export's id. description: type: string description: Export's description. dimensions: type: array description: The dimensions that will be exported. If not provided, all dimensions will be exported. items: type: string description: The dimensions that will be exported. If not provided, all dimensions will be exported. tables: type: array description: The tables that will be exported. If not provided, all tables will be exported. items: type: string description: The tables that will be exported. If not provided, all tables will be exported. enum: - SEARCHES - CLICKS - CUSTOM_EVENTS - KEYWORDS - GROUPS - ALL_EVENTS exportFormat: type: string description: The format of the generated CSV files. enum: - EXCEL - NO_NEWLINE default: EXCEL useDisplayNames: type: boolean description: Whether to use the display names in the export's header. If false, the api names will be used. default: false description: An export. ExportDownloadLinkResponseV15: required: - id type: object properties: id: type: string description: The export's unique identifier downloadLink: type: string description: The export download link. Only appears when export is ready format: url description: Export's download link ExportRowCountLimitV15: type: object properties: exportRowCountLimit: type: integer description: The maximum number of rows allowed in an export format: int64 description: Export's row count limit FilterIdResponseV15: type: object properties: id: type: string description: A filter id. description: A filter id. FilterModelV15: required: - displayName - value type: object properties: displayName: type: string description: The display name of the filter. value: type: string description: The actual value of the filter. description: A filter. FilterResponseV15: type: object properties: id: type: string description: The filter id. displayName: type: string description: The filter display name. account: type: string description: The filter account. type: type: string description: The filter type. Can be 'permissions' or 'reporting'. value: type: string description: The actual filter. description: A filter. FilterTargetsResponseV15: type: object properties: targetedUsers: type: array description: The users targeted by the filter. items: $ref: '#/components/schemas/UserResponseV15' targetedGroups: type: array description: The groups targeted by the filter. items: $ref: '#/components/schemas/GroupResponseV15' description: Collections of users and groups targeted by the filter GroupResponseV15: type: object properties: groupId: type: string description: The group id. account: type: string description: The group account. filters: uniqueItems: true type: array description: The filters that are applied to the users of the group. items: type: string description: The filters that are applied to the users of the group. reports: uniqueItems: true type: array description: The reports the users of the group can view. items: type: string description: The reports the users of the group can view. description: A group of users. UserResponseV15: type: object properties: userId: type: string description: The user id. account: type: string description: The user account. filters: uniqueItems: true type: array description: The filters that are applied to the user items: type: string description: The filters that are applied to the user reports: uniqueItems: true type: array description: The reports the user can view. items: type: string description: The reports the user can view. description: A user. FiltersResponseV15: type: object properties: filters: type: array description: The filters that are applied to the user items: $ref: '#/components/schemas/FilterResponseV15' description: The filters that are applied to the user FilterTargetsModelV15: type: object properties: targetedUsers: uniqueItems: true type: array description: The ids of the users targeted by the filter. items: type: string description: The ids of the users targeted by the filter. targetedGroups: uniqueItems: true type: array description: The ids of the groups targeted by the filter. items: type: string description: The ids of the groups targeted by the filter. description: The targets of a permission filter. GroupsResponseV15: type: object properties: groups: uniqueItems: true type: array description: A collection of groups items: $ref: '#/components/schemas/GroupResponseV15' description: A collection of groups FilterValueModelV15: required: - id - value type: object properties: value: type: string description: The actual value of the filter. id: type: boolean description: Whether the value is a persisted filter ID or a filter value description: A filter value. MetricResponseV15: type: object properties: metricName: type: string description: The metric name. Also acts as a unique identifier. displayName: type: string description: A name that can be used for displaying the metric in UI. type: type: string description: The type of the metric value. higherIsBetter: type: boolean description: Whether a higher value is better. For example, higher clicks is better, higher average click rank is bad. A null value indicates that it depends on the context. percentage: type: boolean description: Whether the metric must be interpreted as a percentage. summable: type: boolean description: Whether the metric value is summable. eventTypes: uniqueItems: true type: array description: The list of event types that might be used to calculate this metric. items: type: string description: The list of event types that might be used to calculate this metric. availableInVisit: type: boolean description: Whether the dimension is available in a visit's statistics. description: The details of a metric. MetricsResponseV15: type: object properties: metricResponses: type: array description: A collection of available metrics items: $ref: '#/components/schemas/MetricResponseV15' description: A collection of available metrics SnowflakeUserResponseV15: type: object properties: username: type: string description: The user login name. email: type: string description: The e-mail address currently associated with the user. daysToExpiry: type: number description: The number of days before the user expires. format: double description: A user from a Snowflake account CreateSnowflakeUserModelV15: required: - email - username type: object properties: username: type: string description: The username, which will be used when logging into the Snowflake account email: type: string description: The user's e-mail, where password setup and reset URLs will be sent daysToExpiry: type: integer description: The number of days before the user expiration, if not defined, the user will never expire. format: int32 description: Details required when creating a new Snowflake user SnowflakeCreditUsageResponseV15: type: object properties: creditsUsed: type: number description: The total number of warehouse compute credits used. format: double description: The compute credit usage for a Snowflake account over a date range. SnowflakeReaderAccountEndpointResponseV15: type: object properties: endpoint: type: string description: The endpoint of the account description: A snowflake reader account's endpoint SnowflakeNetworkPolicyResponseV15: type: object properties: allowedIpAddresses: uniqueItems: true type: array description: The set of IPv4 addresses (with optional subnets) that are allowed access to the Snowflake account. items: type: string description: The set of IPv4 addresses (with optional subnets) that are allowed access to the Snowflake account. blockedIpAddresses: uniqueItems: true type: array description: The set of IPv4 addresses (with optional subnets) that are denied access to the Snowflake account. items: type: string description: The set of IPv4 addresses (with optional subnets) that are denied access to the Snowflake account. description: The policy that specifies options for managing network configurations to the Snowflake service. SnowflakeReaderAccountStateResponseV15: type: object properties: snowflakeReaderAccountStatus: type: string description: The status of the account enum: - AVAILABLE description: A snowflake reader account's state SnowflakeNetworkPolicyModelV15: required: - allowedIpAddresses type: object properties: allowedIpAddresses: uniqueItems: true type: array description: The set of IPv4 addresses (with optional subnets) that are allowed access to the Snowflake account. items: type: string description: The set of IPv4 addresses (with optional subnets) that are allowed access to the Snowflake account. blockedIpAddresses: uniqueItems: true type: array description: The set of IPv4 addresses (with optional subnets) that are denied access to the Snowflake account. items: type: string description: The set of IPv4 addresses (with optional subnets) that are denied access to the Snowflake account. description: Details required when creating a new Snowflake network policy UpdateSnowflakeUserExpirationRequestModelV15: type: object properties: daysToExpiry: type: integer description: The number of days before the user expiration. format: int32 description: Details required when changing the expiration of a Snowflake user ReportIdResponseV15: type: object properties: id: type: string description: The report id. description: A report id. ReportModelV15: required: - allAnalyticsViewer - configuration - displayName - type type: object properties: displayName: type: string description: The display name of the report. type: type: string description: The type of the report. Must be either 'explorer' or 'dashboard'. enum: - DASHBOARD - EXPLORER allAnalyticsViewer: type: boolean description: Whether the report should be available to all analytics viewer. configuration: type: object additionalProperties: type: object description: The configuration of the report. Must be a json. description: The configuration of the report. Must be a json. filters: uniqueItems: true type: array description: The ids of the persisted filters associated with the report. items: type: string description: The ids of the persisted filters associated with the report. description: The configuration of a report. ReportResponseV15: type: object properties: id: type: string description: The report id. account: type: string description: The report account. displayName: type: string description: The report display name. type: type: string description: The report type. configuration: type: object additionalProperties: type: object description: The report configuration. description: The report configuration. allAnalyticsViewer: type: boolean description: Whether the report is available to all analytics viewer. filters: uniqueItems: true type: array description: List of associated filters. items: type: string description: List of associated filters. description: A report configuration. ReportsResponseV15: type: object properties: reports: uniqueItems: true type: array description: The reports the user can view. items: $ref: '#/components/schemas/ReportResponseV15' description: The reports the user can view. ReportAccessResponseV15: type: object properties: accessType: type: string description: The access type of the report. Can be PUBLIC or PRIVATE. enum: - PUBLIC - PRIVATE allowedUsers: type: array description: The users allowed to access the specified report. items: $ref: '#/components/schemas/UserResponseV15' allowedGroups: type: array description: The groups allowed to access the specified report. items: $ref: '#/components/schemas/GroupResponseV15' description: The users and groups allowed to access the report TemplateResponseV15: type: object properties: id: type: string description: The template id. configuration: type: object additionalProperties: type: object description: The JSON report configuration of the template. description: The JSON report configuration of the template. title: type: string description: The template title. description: type: string description: The template description. category: type: string description: The template category. description: Information about a template. TemplateMetadataResponseV15: type: object properties: id: type: string description: The template id. title: type: string description: The template title. description: type: string description: The template description. category: type: string description: The template category. description: Information about a template. ReportUsersResponseV15: type: object properties: access: type: string description: The access type of the report. Can be PUBLIC or PRIVATE. enum: - PUBLIC - PRIVATE allowedUsers: type: array description: The users allowed to access the specified report. items: $ref: '#/components/schemas/UserResponseV15' description: The users allowed to access the specified report. ReportAccessModelV15: type: object properties: accessType: type: string description: Whether the report is public or private. Allowed values are 'PUBLIC', 'PRIVATE'. enum: - PUBLIC - PRIVATE - PUBLIC - PRIVATE allowedUsers: uniqueItems: true type: array description: The ids of the users allowed to access the report. items: type: string description: The ids of the users allowed to access the report. allowedGroups: uniqueItems: true type: array description: The ids of the groups allowed to access the report. items: type: string description: The ids of the groups allowed to access the report. description: The access model of a report. SnowflakeDataSharingAccountModelV15: required: - accountLocator - snowflakeRegion type: object properties: accountLocator: type: string description: The Snowflake account locator. snowflakeRegion: type: string description: The Snowflake region identifier. description: Snowflake account information for Secure Data Sharing. SnowflakeDataSharingRegionsResponseV15: required: - primaryRegion - secondaryRegions type: object properties: primaryRegion: type: string description: The primary Snowflake region. secondaryRegions: uniqueItems: true type: array description: Other supported Snowflake regions. items: type: string description: Other supported Snowflake regions. description: The Snowflake regions supported for Secure Data Sharing. SnowflakeDataSharingAccountResponseV15: required: - locator - region type: object properties: locator: type: string description: The Snowflake account locator. region: type: string description: The region the Snowflake account resides in. createdAt: type: string description: The date and time at which the share was initiated. format: date-time status: type: string description: The share status of the account. enum: - UNKNOWN - PENDING - ACTIVE - INVALID - UNKNOWN - PENDING - ACTIVE - INVALID errorMessage: type: string description: The error message in case of an 'UNKNOWN' or 'INVALID' status. description: The details of a Snowflake account for Secure Data Sharing. CombinedDataResponseV15: required: - combinations type: object properties: combinations: type: array description: The metrics/dimensions combinations items: type: object additionalProperties: type: object description: The metrics/dimensions combinations description: The metrics/dimensions combinations uniqueCounts: type: object additionalProperties: type: object description: The unique counts for the different values of all specified dimensions description: The unique counts for the different values of all specified dimensions totalNumberOfResults: type: integer description: The total number of combinations available format: int32 description: The values of the metrics combined by dimensions GlobalAggregatedDataResponseV15: required: - globalDatas type: object properties: globalDatas: type: object additionalProperties: type: object additionalProperties: type: number description: The global values by metrics. Usually a unique count, a daily count or daily average description: The global values by metrics. Usually a unique count, a daily count or daily average description: The global values by metrics. Usually a unique count, a daily count or daily average description: The global aggregated values by metrics GraphAggregatedDataResponseV15: required: - dataPoints - totals type: object properties: dataPoints: type: array description: A collection of data points items: $ref: '#/components/schemas/DataPoint' totals: type: object additionalProperties: type: number description: The totals for the requested metrics. description: The totals for the requested metrics. stats: type: object additionalProperties: $ref: '#/components/schemas/SummaryStatisticsPojo' description: The sum, average, max and min for the requested metrics. description: The data points to be used in a graph, aggregated by the specified time interval. VisitsStatisticsResponseV15: required: - visits type: object properties: visits: type: array description: The visits matching the specified criteria items: $ref: '#/components/schemas/VisitStatisticsResponseV15' totalNumberOfVisits: type: integer description: The total number of visits matching format: int32 description: The visits matching the specified criteria UserDataDeleteResponseV15: type: object properties: message: type: string description: System response to user data delete request userId: type: string description: The user Id. account: type: string description: The user account. description: A user delete request response UserStatisticsResponseV15: type: object properties: userId: type: string description: The user id. account: type: string description: The user account. stats: type: object additionalProperties: type: integer description: The number of search, click, and custom events logged by the user format: int64 description: The number of search, click, and custom events logged by the user description: A user's statistics summary. securitySchemes: v8: type: oauth2 flows: implicit: authorizationUrl: https://platform.cloud.coveo.com/oauth/authorize scopes: full: ''