OpenAPI Specification
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:
# --- truncated at 32 KB (265 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coveo/refs/heads/main/openapi/coveo-usage-analytics-read-openapi-original.yml