API docs by Redocly

Usage Analytics Read API (v1)

Dimensions API - Version 14

Get all the dimensions Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
query Parameters
includeCustom
boolean
Default: true

Whether to include custom dimensions within the results.

includeOnlyParents
boolean
Default: false

This will filter out dimensions which are covered by others. Only parent/master dimensions will be output

org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all the custom dimensions Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
query Parameters
includeOnlyParents
boolean
Default: false

This will filter out dimensions which are covered by others. Only parent/master dimensions will be output

org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a custom dimension Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
query Parameters
event
required
Array of strings unique
Items Enum: "searches" "clicks" "custom_events"

The types of event where this dimension will be added.

name
string

The name of the custom dimension. It should start with the 'c_' prefix. If not present, the prefix will be added automatically.

org
string

The name of the organization (Coveo Cloud V2 only)

updatePastEvents
boolean
Deprecated
Default: false

Whether to update the custom dimension in past events.

Request Body schema: application/json
required

The custom dimension information.

displayName
required
string

The display name of the dimension. Should be human readable

type
required
string
Enum: "TEXT" "NUMBER" "SHORT" "BOOLEAN" "DATE" … 7 more

The type of the dimension

path
Array of strings

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".

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "path": [
    ],
  • "type": "TEXT"
}

Response samples

Content type
application/json
{
  • "apiNames": [
    ],
  • "availableInVisit": true,
  • "custom": true,
  • "displayName": "string",
  • "eventTypes": [
    ],
  • "returnName": "string",
  • "status": "AVAILABLE",
  • "type": "TEXT"
}

Health check for the custom dimensions service Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get the custom dimensions service status Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get a custom dimension Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
apiName
required
string

Format must be EVENT.DIMENSION where EVENT is the event type and DIMENSION is the name of the dimension.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Get a custom dimension Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
apiName
required
string

Format must be EVENT.DIMENSION where EVENT is the event type and DIMENSION is the name of the dimension.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "apiNames": [
    ],
  • "availableInVisit": true,
  • "custom": true,
  • "displayName": "string",
  • "eventTypes": [
    ],
  • "returnName": "string",
  • "status": "AVAILABLE",
  • "type": "TEXT"
}

Create or edit a custom dimension Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
apiName
required
string

Format must be EVENT.DIMENSION where EVENT is the event type and DIMENSION is the name of the dimension.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

updatePastEvents
boolean
Deprecated
Default: false

Whether to update the custom dimension in past events.

Request Body schema: application/json
required

The custom dimension information.

displayName
required
string

The display name of the dimension Should be human readable

type
required
string
Enum: "TEXT" "NUMBER" "SHORT" "BOOLEAN" "DATE" … 7 more

The type of the dimension

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "type": "TEXT"
}

Response samples

Content type
application/json
{
  • "apiNames": [
    ],
  • "availableInVisit": true,
  • "custom": true,
  • "displayName": "string",
  • "eventTypes": [
    ],
  • "returnName": "string",
  • "status": "AVAILABLE",
  • "type": "TEXT"
}

Get the values for a custom dimension Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
dimension
required
string

The dimensions to fetch.

query Parameters
f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

n
integer <int32>

The number of result to include in a page.

org
string

The name of the organization (Coveo Cloud V2 only)

p
integer <int32>

The response's page to access, starting at 1.

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

tz
string
Default: "Z"

Timezone used for calculations.

Responses

Response samples

Content type
application/json
{
  • "values": [
    ]
}

Get a list of dimensions that have data but are not created yet Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
event
required
string
Enum: "searches" "clicks" "custom_events"

The type of event for which to look for suggestions.

query Parameters
depth
integer <int32>
Default: 1000

The number of events to look at when getting suggestions. A larger depth means more suggestions but also slower performance.

from
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

includeValueSamples
boolean
Default: true

Whether value samples should be included in the response.

org
string

The name of the organization (Coveo Cloud V2 only)

to
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

Responses

Response samples

Content type
application/json
{
  • "suggestions": [
    ]
}

Health check for the dimensions service Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get the dimensions service status Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get a dimension Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{
  • "apiNames": [
    ],
  • "availableInVisit": true,
  • "custom": true,
  • "displayName": "string",
  • "eventTypes": [
    ],
  • "returnName": "string",
  • "status": "AVAILABLE",
  • "type": "TEXT"
}

Get the values for a dimension Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
dimension
required
string

The dimensions to fetch.

query Parameters
f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

from
string

from

n
integer <int32>

The number of result to include in a page.

org
string

The name of the organization (Coveo Cloud V2 only)

p
integer <int32>

The response's page to access, starting at 1.

to
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

tz
string
Default: "Z"

Timezone used for calculations.

Responses

Response samples

Content type
application/json
{
  • "values": [
    ]
}

Exports API - Version 14

Lists all exports Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Generate an export Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
query Parameters
f
Array of strings

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.

fc
Array of strings

The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator.

filename
string

Can only contain US-ASCII characters. If none is supplied it will be set to the export's id.

format
string
Default: "EXCEL"
Enum: "EXCEL" "NO_NEWLINE" "EXCEL,NO_NEWLINE"

The format of the generated CSV files.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

fs
Array of strings

The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator.

org
string

The name of the organization (Coveo Cloud V2 only)

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

Responses

Response samples

Content type
application/json
{
  • "author": "string",
  • "description": "string",
  • "downloadLink": "string",
  • "filters": {
    },
  • "from": 0,
  • "id": "string",
  • "size": 0,
  • "startDate": 0,
  • "status": "AVAILABLE",
  • "to": 0
}

Estimate the number of rows in an export Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
query Parameters
f
Array of strings

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.

fc
Array of strings

The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

fs
Array of strings

The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator.

org
string

The name of the organization (Coveo Cloud V2 only)

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

Responses

Response samples

Content type
application/json
{
  • "estimates": {
    }
}

Health check for the exports service Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get the exports service status Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Generate a visit export Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
query Parameters
d
string

Export's description.

f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

filename
string

Can only contain US-ASCII characters. If none is supplied it will be set to the export's id.

fn
Array of strings

The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.

format
string
Default: "EXCEL"
Enum: "EXCEL" "NO_NEWLINE" "EXCEL,NO_NEWLINE"

The format of the generated CSV files.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

org
string

The name of the organization (Coveo Cloud V2 only)

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

Responses

Response samples

Content type
application/json
{
  • "author": "string",
  • "description": "string",
  • "downloadLink": "string",
  • "filters": {
    },
  • "from": 0,
  • "id": "string",
  • "size": 0,
  • "startDate": 0,
  • "status": "AVAILABLE",
  • "to": 0
}

Estimate the number of rows in a visit export Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
query Parameters
f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

fn
Array of strings

The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

org
string

The name of the organization (Coveo Cloud V2 only)

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

Responses

Response samples

Content type
application/json
{
  • "estimates": {
    }
}

Delete an export Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
exportId
required
string

The export's unique identifier.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Get information on an export Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
exportId
required
string

The export's unique identifier.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

redirect
boolean
Default: false

Whether to return a HTTP redirect to the actual file.

Note: for technical reasons, setting this parameter to true will yield an error when calling the endpoint through Swagger user interface.

Responses

Response samples

Content type
application/json
{
  • "author": "string",
  • "description": "string",
  • "downloadLink": "string",
  • "filters": {
    },
  • "from": 0,
  • "id": "string",
  • "size": 0,
  • "startDate": 0,
  • "status": "AVAILABLE",
  • "to": 0
}

Filters API - Version 14

Health check for the filter service Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get all the permission filters Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "filters": [
    ]
}

Create a permission filter Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The filter configuration

displayName
required
string

The display name of the filter.

value
required
string

The actual value of the filter.

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Deletes the specified permission filter Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Get a permission filter Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "account": "string",
  • "displayName": "string",
  • "id": "string",
  • "type": "string",
  • "value": "string"
}

Update a permission filter Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The filter configuration

displayName
required
string

The display name of the filter.

value
required
string

The actual value of the filter.

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Get the users of a permission filter Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set the users of a permission filter Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The users to set the permission on.

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Get all the reporting filters Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "filters": [
    ]
}

Create a reporting filter Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The filter configuration

displayName
required
string

The display name of the filter.

value
required
string

The actual value of the filter.

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Deletes the specified reporting filter Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Gets the specified reporting filter Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "account": "string",
  • "displayName": "string",
  • "id": "string",
  • "type": "string",
  • "value": "string"
}

Update a reporting filter Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The filter configuration

displayName
required
string

The display name of the filter.

value
required
string

The actual value of the filter.

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Gets the status of the filter service Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Metrics API - Version 14

Get all the metrics Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "metricResponses": [
    ]
}

Health check for the metrics service Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get the metrics service status Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get a metric Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
metricName
required
string

metricName

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "displayName": "string",
  • "eventTypes": [
    ],
  • "higherIsBetter": true,
  • "metricName": "string",
  • "percentage": true,
  • "type": "string"
}

Reports API - Version 14

Get the persisted reports of one or all types Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
query Parameters
includeConfig
boolean
Default: true

Whether to include the detailed configuration of the report in the response.

org
string

The name of the organization (Coveo Cloud V2 only)

type
string
Enum: "DASHBOARD" "EXPLORER" "EXPLORER,DASHBOARD"

The type of the report. Must be either 'explorer' or 'dashboard'.

Responses

Response samples

Content type
application/json
{
  • "reports": [
    ]
}

Create a report Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The report configuration

allAnalyticsViewer
required
boolean

Whether the report should be available to all analytics viewer.

required
object

The configuration of the report. Must be a json.

displayName
required
string

The display name of the report.

type
required
string
Enum: "DASHBOARD" "EXPLORER"

The type of the report. Must be either 'explorer' or 'dashboard'.

filters
Array of strings unique

The ids of the persisted filters associated with the report.

Responses

Request samples

Content type
application/json
{
  • "allAnalyticsViewer": true,
  • "configuration": {
    },
  • "displayName": "string",
  • "filters": [
    ],
  • "type": "DASHBOARD"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Health check for the reports service Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get the reports service status Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Delete a report Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
reportId
required
string

The unique identifier of a report. This id is generated by the server when creating a report.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Get a report Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
reportId
required
string

The unique identifier of a report. This id is generated by the server when creating a report.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "account": "string",
  • "allAnalyticsViewer": true,
  • "configuration": {
    },
  • "displayName": "string",
  • "filters": [
    ],
  • "id": "string",
  • "type": "string"
}

Update a report Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
reportId
required
string

The unique identifier of a report. This id is generated by the server when creating a report.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The report configuration

allAnalyticsViewer
required
boolean

Whether the report should be available to all analytics viewer.

required
object

The configuration of the report. Must be a json.

displayName
required
string

The display name of the report.

type
required
string
Enum: "DASHBOARD" "EXPLORER"

The type of the report. Must be either 'explorer' or 'dashboard'.

filters
Array of strings unique

The ids of the persisted filters associated with the report.

Responses

Request samples

Content type
application/json
{
  • "allAnalyticsViewer": true,
  • "configuration": {
    },
  • "displayName": "string",
  • "filters": [
    ],
  • "type": "DASHBOARD"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Gets the users that can view the specified report. Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
reportId
required
string

The unique identifier of a report. This id is generated by the server when creating a report.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "access": "PUBLIC",
  • "allowedUsers": [
    ]
}

Set the users who are allowed to view a report Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
reportId
required
string

The unique identifier of a report. This id is generated by the server when creating a report.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The IDs of the allowed users.

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Statistics API - Version 14

Get metrics combined with dimensions for a date range Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024. There is one value of each metric for every possible dimension combination.

Authorizations:
v8
query Parameters
asc
boolean
Default: true

Whether to sort by ascending order.

bindOnLastSearch
boolean
Default: true

bindOnLastSearch

d
Array of strings
Default: "Z"

Timezone used for calculations.

f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

fm
Array of strings

The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND operator.

format
string
Default: "JSON"
Enum: "JSON" "CSV" "JSON,CSV"

The format of the response. Default is JSON.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

includeMetadata
boolean
Default: true

Whether to include metadata regarding the results (total count and unique counts, if applicable).

m
required
Array of strings

The metrics to fetch.

n
integer <int32>

The number of result to include in a page.

org
string

The name of the organization (Coveo Cloud V2 only)

p
integer <int32>

The response's page to access, starting at 1.

s
string

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.

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

tz
string
Default: "Z"

Timezone used for calculations.

Responses

Response samples

Content type
{
  • "combinations": [
    ],
  • "totalNumberOfResults": 0,
  • "uniqueCounts": {
    }
}

Get global data for each metric for a date range Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024. Global data contain the total, the daily peak and the daily average.

Authorizations:
v8
query Parameters
bindOnLastSearch
boolean
Default: true

bindOnLastSearch

d
Array of strings

The dimensions to fetch. Required when the Activity metric is requested as it has to be based on a dimension.

f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

i
string
Default: "DAY"
Enum: "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" … 1 more

The interval on which data will be grouped. Default value is DAY.

m
required
Array of strings

The metrics to fetch.

org
string

The name of the organization (Coveo Cloud V2 only)

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

tz
string
Default: "Z"

Timezone used for calculations.

Responses

Response samples

Content type
application/json
{
  • "globalDatas": {
    }
}

Get graph data points for the metrics for a date range Deprecated

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.

Authorizations:
v8
query Parameters
bindOnLastSearch
boolean
Default: true

bindOnLastSearch

f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

i
string
Default: "DAY"
Enum: "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" … 1 more

The interval on which data will be grouped. Default value is DAY.

m
required
Array of strings

The metrics to fetch.

org
string

The name of the organization (Coveo Cloud V2 only)

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

tz
string
Default: "Z"

Timezone used for calculations.

Responses

Response samples

Content type
application/json
{
  • "dataPoints": [
    ],
  • "stats": {
    },
  • "totals": {
    }
}

Health check for the statistics service Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get the statistics service status Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get trends of a metric combined with dimensions for a date range Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024. There is one value of each metric for every possible dimension combination.

Authorizations:
v8
query Parameters
asc
boolean
Default: true

Whether to sort by ascending order.

bindOnLastSearch
boolean
Default: true

bindOnLastSearch

d
Array of strings
Default: "Z"

Timezone used for calculations.

f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

fm
Array of strings

The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND operator.

format
string
Default: "JSON"
Enum: "JSON" "CSV"

The format of the response. Default is JSON.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

includeMetadata
boolean
Default: true

Whether to include metadata regarding the results (total count and unique counts, if applicable).

m
required
Array of strings

The metrics to fetch.

n
integer <int32>

The number of result to include in a page.

org
string

The name of the organization (Coveo Cloud V2 only)

p
integer <int32>

The response's page to access, starting at 1.

previousFrom
string

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.

previousTo
string

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.

s
string

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.

t
required
Array of strings

The trends to caculate.

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

tz
string
Default: "Z"

Timezone used for calculations.

Responses

Response samples

Content type
{
  • "combinations": [
    ],
  • "totalNumberOfResults": 0,
  • "uniqueCounts": {
    }
}

Get the details of the visits matching the specified criteria Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
query Parameters
asc
boolean
Default: false

Whether to sort by ascending order.

d
Array of strings

The dimensions to fetch.

f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

fn
Array of strings

The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

includeMetadata
boolean
Default: true

Whether to include metadata regarding the results (total count and unique counts, if applicable).

n
integer <int32>

The number of result to include in a page.

org
string

The name of the organization (Coveo Cloud V2 only)

p
integer <int32>

The response's page to access, starting at 1.

s
string
Default: "eventDatetime"

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.

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

tz
string
Default: "Z"

Timezone used for calculations.

Responses

Response samples

Content type
application/json
{
  • "totalNumberOfVisits": 0,
  • "visits": [
    ]
}

Force a visit view update Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024. Global data contain the total, the daily peak and the daily average.

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Users API - Version 14

Health check for the users service Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get the users service status Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get a user Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
userId
required
string

The unique identifier of a user.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "account": "string",
  • "filters": [
    ],
  • "reports": [
    ],
  • "userId": "string"
}

Get the data level filters that apply to a user Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
userId
required
string

The unique identifier of a user.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "filters": [
    ]
}

Set the filters that will be applied to a user query Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
userId
required
string

The unique identifier of a user.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The filters that will be applied to the user. Must be a persisted filter ID

Array
id
required
boolean

Whether the value is a persisted filter ID or a filter value

value
required
string

The actual value of the filter.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get the reports that a user can access Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
userId
required
string

The unique identifier of a user.

query Parameters
includeConfig
boolean
Default: true

Whether to include the detailed configuration of the report in the response.

org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "reports": [
    ]
}

Set which reports a user can access Deprecated

This endpoint is deprecated and will be removed on October 1st, 2024.

Authorizations:
v8
path Parameters
userId
required
string

The unique identifier of a user.

query Parameters
org
string

The unique identifier of a user.

Request Body schema: application/json
required

The IDs of the reports the user can access

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Administration API - Version 15

Get an account

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "internalEventIps": [
    ],
  • "name": "string",
  • "status": "AVAILABLE",
  • "useStrictFieldValidation": true
}

Edit an account

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json

The account information

internalEventIps
Array of strings unique

A set of IP addresses or CIDR blocks from which events will be considered internal.

useStrictFieldValidation
boolean

Deprecated. Will be removed in April 2025.

Whether to use the strict field validation on incoming events.

Responses

Request samples

Content type
application/json
{
  • "internalEventIps": [
    ],
  • "useStrictFieldValidation": true
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "internalEventIps": [
    ],
  • "name": "string",
  • "status": "AVAILABLE",
  • "useStrictFieldValidation": true
}

Get example values that would be rejected by strict validation for the specified dimension Deprecated

This endpoint is deprecated and will be removed in April 2025.

Authorizations:
v8
query Parameters
d
required
string

The dimension to fetch.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

n
integer <int32>

The number of results to include in a page.

org
string

The name of the organization (Coveo Cloud V2 only)

p
integer <int32>

The response's page to access, starting at 1.

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

Responses

Response samples

Content type
application/json
{
  • "dimensionName": "string",
  • "validationTestResults": [
    ]
}

Data Health API - Version 15

Get failed instances for a data health criterion

Authorizations:
v8
query Parameters
criterionId
required
string

The data health criterion for which the failed instances should be returned.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

group
required
string

The group for which data health information should be returned.

org
string

The name of the organization (Coveo Cloud V2 only)

page
integer <int32>
Default: 0

The response's page to access, starting at 0.

perPage
integer <int32>
Default: 50

The number of results to include in a page.

scopeValue
string

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.

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

trackingId
Array of strings

The tracking IDs for which the results should be returned.

Responses

Response samples

Content type
application/json
{
  • "failedInstances": [
    ]
}

Get health information about events

Authorizations:
v8
query Parameters
clientId
Array of strings

A set of client IDs for which the events will be returned.

eventSource
Array of strings

A set of event sources for which the events will be returned.

eventType
Array of strings

A set of event types for which the events will be returned.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

healthStatus
string
Enum: "VALID" "INVALID"

A health status for which the events will be returned.

org
string

The name of the organization (Coveo Cloud V2 only)

page
integer <int32>
Default: 0

The response's page to access, starting at 0.

perPage
integer <int32>
Default: 50

The number of results to include in a page.

searchHub
Array of strings

A set of search hubs for which the events will be returned.

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

trackingId
Array of strings

The tracking IDs for which the results should be returned.

visitId
Array of strings

A set of visit IDs for which the events will be returned.

Responses

Response samples

Content type
application/json
{
  • "events": [
    ]
}

Get the payload of an event.

Authorizations:
v8
query Parameters
eventId
required
string

The id of the event for which to return information.

org
string

The name of the organization (Coveo Cloud V2 only)

timestamp
required
string

The timestamp of the event. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

Responses

Response samples

Content type
application/json
{
  • "eventId": "string",
  • "eventPayload": { },
  • "timestamp": "string"
}

Get problems about events

Authorizations:
v8
query Parameters
eventType
Array of strings

A set of event types for which the events will be returned.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

org
string

The name of the organization (Coveo Cloud V2 only)

page
integer <int32>
Default: 0

The response's page to access, starting at 0.

perPage
integer <int32>
Default: 50

The number of results to include in a page.

searchHub
Array of strings

A set of search hubs for which the events will be returned.

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

trackingId
Array of strings

The tracking IDs for which the results should be returned.

Responses

Response samples

Content type
application/json
{
  • "problems": [
    ]
}

List facet values for event browser

Authorizations:
v8
query Parameters
clientId
Array of strings

A set of client IDs for which the events will be returned.

eventSource
Array of strings

A set of event sources for which the events will be returned.

eventType
Array of strings

A set of event types for which the events will be returned.

facet
required
string
Enum: "EVENT_SOURCE" "EVENT_TYPE" "HEALTH_STATUS" "SEARCH_HUB" "TRACKING_ID"

The facet for which the values should be listed

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

healthStatus
string
Enum: "VALID" "INVALID"

A health status for which the events will be returned.

org
string

The name of the organization (Coveo Cloud V2 only)

searchHub
Array of strings

A set of search hubs for which the events will be returned.

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

trackingId
Array of strings

The tracking IDs for which the results should be returned.

visitId
Array of strings

A set of visit IDs for which the events will be returned.

Responses

Response samples

Content type
application/json
{
  • "values": [
    ]
}

Get a listing of data health groups

Authorizations:
v8
query Parameters
category
Array of strings

The categories of rules for which data health should be displayed.

feature
Array of strings

The feature for which data health should be computed.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

org
string

The name of the organization (Coveo Cloud V2 only)

page
integer <int32>
Default: 0

The response's page to access, starting at 0.

perPage
integer <int32>
Default: 10

The number of results to include in a page.

showEmptyGroups
boolean
Default: false

Whether or not groups with zero event validated should be shown

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

trackingId
Array of strings

The tracking IDs for which the results should be returned.

Responses

Response samples

Content type
application/json
{
  • "groups": [
    ]
}

Get detailed information about a data health group

Authorizations:
v8
query Parameters
category
Array of strings

The categories of rules for which data health should be displayed.

feature
Array of strings

The feature for which data health should be computed.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

group
required
string

The group for which data health information should be returned.

org
string

The name of the organization (Coveo Cloud V2 only)

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

trackingId
Array of strings

The tracking IDs for which the results should be returned.

Responses

Response samples

Content type
application/json
{
  • "criteria": [
    ]
}

Get the data health overview

Authorizations:
v8
query Parameters
category
Array of strings

The categories of rules for which data health should be displayed.

feature
Array of strings

The feature for which data health should be computed.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

org
string

The name of the organization (Coveo Cloud V2 only)

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

trackingId
Array of strings

The tracking IDs for which the results should be returned.

Responses

Response samples

Content type
application/json
{
  • "failedValidations": 0,
  • "score": 0,
  • "severityBreakdown": {
    },
  • "totalValidations": 0
}

Get the data health service status

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Dimensions API - Version 15

Get all the dimensions

Authorizations:
v8
query Parameters
includeCustom
boolean
Default: true

Whether to include custom dimensions within the results.

includeOnlyParents
boolean
Default: false

This will filter out dimensions which are covered by others. Only parent/master dimensions will be output

org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all the custom dimensions

Authorizations:
v8
query Parameters
includeOnlyParents
boolean
Default: false

This will filter out dimensions which are covered by others. Only parent/master dimensions will be output

org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a custom dimension

Authorizations:
v8
query Parameters
event
required
Array of strings unique
Items Enum: "searches" "clicks" "custom_events"

The types of event where this dimension will be added.

name
string

The name of the custom dimension. It should start with the 'c_' prefix. If not present, the prefix will be added automatically.

org
string

The name of the organization (Coveo Cloud V2 only)

updatePastEvents
boolean
Deprecated
Default: false

Whether to update the custom dimension in past events.

Request Body schema: application/json
required

The custom dimension information.

displayName
required
string

The display name of the dimension. Should be human readable

type
required
string
Enum: "TEXT" "NUMBER" "SHORT" "BOOLEAN" "DATE" … 7 more

The type of the dimension

path
Array of strings

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".

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "path": [
    ],
  • "type": "TEXT"
}

Response samples

Content type
application/json
{
  • "apiNames": [
    ],
  • "availableInVisit": true,
  • "custom": true,
  • "displayName": "string",
  • "eventTypes": [
    ],
  • "path": [
    ],
  • "returnName": "string",
  • "status": "AVAILABLE",
  • "type": "TEXT"
}

Health check for the custom dimensions service

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get the custom dimensions service status

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Delete a custom dimension

Authorizations:
v8
path Parameters
apiName
required
string

Format must be EVENT.DIMENSION where EVENT is the event type and DIMENSION is the name of the dimension.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Get a custom dimension

Authorizations:
v8
path Parameters
apiName
required
string

Format must be EVENT.DIMENSION where EVENT is the event type and DIMENSION is the name of the dimension.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "apiNames": [
    ],
  • "availableInVisit": true,
  • "custom": true,
  • "displayName": "string",
  • "eventTypes": [
    ],
  • "path": [
    ],
  • "returnName": "string",
  • "status": "AVAILABLE",
  • "type": "TEXT"
}

Create or edit a custom dimension

Authorizations:
v8
path Parameters
apiName
required
string

Format must be EVENT.DIMENSION where EVENT is the event type and DIMENSION is the name of the dimension.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

updatePastEvents
boolean
Deprecated
Default: false

Whether to update the custom dimension in past events.

Request Body schema: application/json
required

The custom dimension information.

displayName
required
string

The display name of the dimension. Should be human readable

type
required
string
Enum: "TEXT" "NUMBER" "SHORT" "BOOLEAN" "DATE" … 7 more

The type of the dimension

path
Array of strings

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".

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "path": [
    ],
  • "type": "TEXT"
}

Response samples

Content type
application/json
{
  • "apiNames": [
    ],
  • "availableInVisit": true,
  • "custom": true,
  • "displayName": "string",
  • "eventTypes": [
    ],
  • "path": [
    ],
  • "returnName": "string",
  • "status": "AVAILABLE",
  • "type": "TEXT"
}

Get the values for a custom dimension

Authorizations:
v8
path Parameters
dimension
required
string

The dimensions to fetch.

query Parameters
f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

n
integer <int32>

The number of results to include in a page.

org
string

The name of the organization (Coveo Cloud V2 only)

p
integer <int32>

The response's page to access, starting at 1.

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

tz
string
Default: "Z"

Timezone used for calculations.

Responses

Response samples

Content type
application/json
{
  • "values": [
    ]
}

Get a list of dimensions that have data but are not created yet

Authorizations:
v8
path Parameters
event
required
string
Enum: "searches" "clicks" "custom_events"

The type of event for which to look for suggestions.

query Parameters
depth
integer <int32>
Default: 1000

The number of events to look at when getting suggestions. A larger depth means more suggestions but also slower performance.

from
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

includeValueSamples
boolean
Default: true

Whether value samples should be included in the response.

org
string

The name of the organization (Coveo Cloud V2 only)

to
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

Responses

Response samples

Content type
application/json
{
  • "suggestions": [
    ]
}

Get all the exportable dimensions

Authorizations:
v8
query Parameters
includeCustom
boolean
Default: true

Whether to include custom dimensions within the results.

includeOnlyParents
boolean
Default: false

This will filter out dimensions which are covered by others. Only parent/master dimensions will be output

org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Health check for the dimensions service

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get the dimensions service status

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get a dimension

Authorizations:
v8
path Parameters
apiName
required
string

Format must be EVENT.DIMENSION where EVENT is the event type and DIMENSION is the name of the dimension.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "apiNames": [
    ],
  • "availableInVisit": true,
  • "custom": true,
  • "displayName": "string",
  • "eventTypes": [
    ],
  • "path": [
    ],
  • "returnName": "string",
  • "status": "AVAILABLE",
  • "type": "TEXT"
}

Get the values for a dimension

Authorizations:
v8
path Parameters
dimension
required
string

The dimensions to fetch.

query Parameters
cached
string

cached

f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

n
integer <int32>

The number of results to include in a page.

org
string

The name of the organization (Coveo Cloud V2 only)

p
integer <int32>

The response's page to access, starting at 1.

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

tz
string
Default: "Z"

Timezone used for calculations.

Responses

Response samples

Content type
application/json
{
  • "values": [
    ]
}

Exports API - Version 15

Lists all exports

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Generate an export

Authorizations:
v8
query Parameters
d
string

Export's description.

dimensions
Array of strings

The dimensions that will be exported. If not provided, all dimensions will be exported.

f
Array of strings

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.

fc
Array of strings

The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator.

filename
string

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.

format
string
Default: "EXCEL"
Enum: "EXCEL" "NO_NEWLINE"

The format of the generated CSV files.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

fs
Array of strings

The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator.

org
string

The name of the organization (Coveo Cloud V2 only)

tables
Array of strings
Items Enum: "SEARCHES" "CLICKS" "CUSTOM_EVENTS" "KEYWORDS" "GROUPS" … 1 more

The tables that will be exported. If not provided, all tables will be exported.

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

useDisplayNames
boolean
Default: false

Whether to use the display names in the export's header. If false, the api names will be used.

Responses

Response samples

Content type
application/json
{
  • "author": "string",
  • "description": "string",
  • "dimensions": [
    ],
  • "downloadLink": "string",
  • "downloadable": true,
  • "filters": {
    },
  • "from": 0,
  • "id": "string",
  • "replayable": true,
  • "scheduleId": "string",
  • "size": 0,
  • "startDate": 0,
  • "status": "AVAILABLE",
  • "tables": [
    ],
  • "to": 0,
  • "usingDisplayNames": true
}

Generate an export (with parameters as request body)

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required
commonFilters
Array of strings

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.

customEventsFilters
Array of strings

The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator.

description
string

Export's description.

dimensions
Array of strings

The dimensions that will be exported. If not provided, all dimensions will be exported.

exportFormat
string
Default: "EXCEL"
Enum: "EXCEL" "NO_NEWLINE"

The format of the generated CSV files.

filename
string

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.

from
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

searchesFilters
Array of strings

The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator.

tables
Array of strings
Items Enum: "SEARCHES" "CLICKS" "CUSTOM_EVENTS" "KEYWORDS" "GROUPS" … 1 more

The tables that will be exported. If not provided, all tables will be exported.

to
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

useDisplayNames
boolean
Default: false

Whether to use the display names in the export's header. If false, the api names will be used.

Responses

Request samples

Content type
application/json
{
  • "commonFilters": [
    ],
  • "customEventsFilters": [
    ],
  • "description": "string",
  • "dimensions": [
    ],
  • "exportFormat": "EXCEL",
  • "filename": "string",
  • "from": "string",
  • "searchesFilters": [
    ],
  • "tables": [
    ],
  • "to": "string",
  • "useDisplayNames": false
}

Response samples

Content type
application/json
{
  • "author": "string",
  • "description": "string",
  • "dimensions": [
    ],
  • "downloadLink": "string",
  • "downloadable": true,
  • "filters": {
    },
  • "from": 0,
  • "id": "string",
  • "replayable": true,
  • "scheduleId": "string",
  • "size": 0,
  • "startDate": 0,
  • "status": "AVAILABLE",
  • "tables": [
    ],
  • "to": 0,
  • "usingDisplayNames": true
}

Estimate the number of rows in an export

Authorizations:
v8
query Parameters
f
Array of strings

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.

fc
Array of strings

The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

fs
Array of strings

The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator.

org
string

The name of the organization (Coveo Cloud V2 only)

tables
Array of strings
Items Enum: "SEARCHES" "CLICKS" "CUSTOM_EVENTS" "KEYWORDS" "GROUPS" … 1 more

The tables that will be exported. If not provided, all tables will be exported.

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

Responses

Response samples

Content type
application/json
{
  • "estimates": {
    }
}

Health check for the exports service

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get the maximum allowed number of rows an export can have

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "exportRowCountLimit": 0
}

Get all the export schedules

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an export schedule

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

Information about the requested export schedule.

frequency
required
string
Enum: "DAILY" "MONTHLY" "WEEKLY"

The execution frequency of the export schedule

timezone
required
string

The timezone of the export schedule

commonFilters
Array of strings

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.

customEventsFilters
Array of strings

The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator.

dayOfWeek
string
Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" … 2 more

The day of the week on which the export is executed (for weekly exports)

description
string

A description of this export schedule

dimensions
Array of strings

The requested dimensions for the schedule's exports, if specified

exportFormat
string
Enum: "EXCEL" "NO_NEWLINE"

The format of the generated CSV files.

notificationsEmails
Array of strings unique

The email addresses of the users that will be notified when an export is ready.

searchesFilters
Array of strings

The filter that will be applied to the search and click events dimensions. Multiple filter parameters are joined with the AND operator.

tables
Array of strings
Items Enum: "SEARCHES" "CLICKS" "CUSTOM_EVENTS" "KEYWORDS" "GROUPS" … 1 more

The requested tables for the schedule's exports, if specified

usingDisplayNames
boolean

Whether the generated export headers will be using display names.

Responses

Request samples

Content type
application/json
{
  • "commonFilters": [
    ],
  • "customEventsFilters": [
    ],
  • "dayOfWeek": "MONDAY",
  • "description": "string",
  • "dimensions": [
    ],
  • "exportFormat": "EXCEL",
  • "frequency": "DAILY",
  • "notificationsEmails": [
    ],
  • "searchesFilters": [
    ],
  • "tables": [
    ],
  • "timezone": "string",
  • "usingDisplayNames": true
}

Response samples

Content type
application/json
{
  • "author": "string",
  • "dayOfWeek": "MONDAY",
  • "description": "string",
  • "dimensions": [
    ],
  • "filters": {
    },
  • "frequency": "DAILY",
  • "id": "string",
  • "notificationsEmails": [
    ],
  • "tables": [
    ],
  • "timezone": "string",
  • "usingDisplayNames": true
}

Delete an export schedule

Authorizations:
v8
path Parameters
exportScheduleId
required
string

The export schedule's unique identifier.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Get information on an export schedule

Authorizations:
v8
path Parameters
exportScheduleId
required
string

The export schedule's unique identifier.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "author": "string",
  • "dayOfWeek": "MONDAY",
  • "description": "string",
  • "dimensions": [
    ],
  • "filters": {
    },
  • "frequency": "DAILY",
  • "id": "string",
  • "notificationsEmails": [
    ],
  • "tables": [
    ],
  • "timezone": "string",
  • "usingDisplayNames": true
}

Update an existing export schedule

Authorizations:
v8
path Parameters
exportScheduleId
required
string

The export schedule's unique identifier.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

Information about the requested export schedule.

frequency
required
string
Enum: "DAILY" "MONTHLY" "WEEKLY"

The execution frequency of the export schedule

timezone
required
string

The timezone of the export schedule

commonFilters
Array of strings

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.

customEventsFilters
Array of strings

The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator.

dayOfWeek
string
Enum: "MONDAY" "TUESDAY" "WEDNESDAY" "THURSDAY" "FRIDAY" … 2 more

The day of the week on which the export is executed (for weekly exports)

description
string

A description of this export schedule

dimensions
Array of strings

The requested dimensions for the schedule's exports, if specified

exportFormat
string
Enum: "EXCEL" "NO_NEWLINE"

The format of the generated CSV files.

notificationsEmails
Array of strings unique

The email addresses of the users that will be notified when an export is ready.

searchesFilters
Array of strings

The filter that will be applied to the search and click events dimensions. Multiple filter parameters are joined with the AND operator.

tables
Array of strings
Items Enum: "SEARCHES" "CLICKS" "CUSTOM_EVENTS" "KEYWORDS" "GROUPS" … 1 more

The requested tables for the schedule's exports, if specified

usingDisplayNames
boolean

Whether the generated export headers will be using display names.

Responses

Request samples

Content type
application/json
{
  • "commonFilters": [
    ],
  • "customEventsFilters": [
    ],
  • "dayOfWeek": "MONDAY",
  • "description": "string",
  • "dimensions": [
    ],
  • "exportFormat": "EXCEL",
  • "frequency": "DAILY",
  • "notificationsEmails": [
    ],
  • "searchesFilters": [
    ],
  • "tables": [
    ],
  • "timezone": "string",
  • "usingDisplayNames": true
}

Response samples

Content type
application/json
{
  • "author": "string",
  • "dayOfWeek": "MONDAY",
  • "description": "string",
  • "dimensions": [
    ],
  • "filters": {
    },
  • "frequency": "DAILY",
  • "id": "string",
  • "notificationsEmails": [
    ],
  • "tables": [
    ],
  • "timezone": "string",
  • "usingDisplayNames": true
}

Get the exports service status

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Generate a visit export

Authorizations:
v8
query Parameters
d
string

Export's description.

dimensions
Array of strings

The dimensions that will be exported. If not provided, all dimensions will be exported.

f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

filename
string

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.

fn
Array of strings

The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.

format
string
Default: "EXCEL"
Enum: "EXCEL" "NO_NEWLINE" "EXCEL,NO_NEWLINE"

The format of the generated CSV files.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

hideEventFilters
Array of strings

Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator.

ordered
boolean
Default: true

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.

org
string

The name of the organization (Coveo Cloud V2 only)

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

useDisplayNames
boolean
Default: false

Whether to use the display names in the export's header. If false, the api names will be used.

Responses

Response samples

Content type
application/json
{
  • "author": "string",
  • "description": "string",
  • "dimensions": [
    ],
  • "downloadLink": "string",
  • "downloadable": true,
  • "filters": {
    },
  • "from": 0,
  • "id": "string",
  • "replayable": true,
  • "scheduleId": "string",
  • "size": 0,
  • "startDate": 0,
  • "status": "AVAILABLE",
  • "tables": [
    ],
  • "to": 0,
  • "usingDisplayNames": true
}

Generate a visit export (with parameters as request body)

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required
description
string

Export's description.

dimensions
Array of strings

The dimensions that will be exported. If not provided, all dimensions will be exported.

exclusionFilters
Array of strings

The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.

exportFormat
string
Default: "EXCEL"
Enum: "EXCEL" "NO_NEWLINE"

The format of the generated CSV files.

filename
string

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.

from
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

hideEventFilters
Array of strings

Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator.

inclusionFilters
Array of strings

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.

ordered
boolean
Default: true

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.

to
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

useDisplayNames
boolean
Default: false

Whether to use the display names in the export's header. If false, the api names will be used.

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "dimensions": [
    ],
  • "exclusionFilters": [
    ],
  • "exportFormat": "EXCEL",
  • "filename": "string",
  • "from": "string",
  • "hideEventFilters": [
    ],
  • "inclusionFilters": [
    ],
  • "ordered": true,
  • "to": "string",
  • "useDisplayNames": false
}

Response samples

Content type
application/json
{
  • "author": "string",
  • "description": "string",
  • "dimensions": [
    ],
  • "downloadLink": "string",
  • "downloadable": true,
  • "filters": {
    },
  • "from": 0,
  • "id": "string",
  • "replayable": true,
  • "scheduleId": "string",
  • "size": 0,
  • "startDate": 0,
  • "status": "AVAILABLE",
  • "tables": [
    ],
  • "to": 0,
  • "usingDisplayNames": true
}

Estimate the number of rows in a visit export

Authorizations:
v8
query Parameters
f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

fn
Array of strings

The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

hideEventFilters
Array of strings

Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator.

org
string

The name of the organization (Coveo Cloud V2 only)

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

Responses

Response samples

Content type
application/json
{
  • "estimates": {
    }
}

Delete an export

Authorizations:
v8
path Parameters
exportId
required
string

The export's unique identifier.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Get information on an export

Authorizations:
v8
path Parameters
exportId
required
string

The export's unique identifier.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

redirect
boolean
Default: false

Whether to return a HTTP redirect to the actual file.

Note: for technical reasons, setting this parameter to true will yield an error when calling the endpoint through Swagger user interface.

Responses

Response samples

Content type
application/json
{
  • "author": "string",
  • "description": "string",
  • "dimensions": [
    ],
  • "downloadLink": "string",
  • "downloadable": true,
  • "filters": {
    },
  • "from": 0,
  • "id": "string",
  • "replayable": true,
  • "scheduleId": "string",
  • "size": 0,
  • "startDate": 0,
  • "status": "AVAILABLE",
  • "tables": [
    ],
  • "to": 0,
  • "usingDisplayNames": true
}

Get the download link of an export

Authorizations:
v8
path Parameters
exportId
required
string

The export's unique identifier.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "downloadLink": "string",
  • "id": "string"
}

Filters API - Version 15

Health check for the filter service

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get all the permission filters

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "filters": [
    ]
}

Create a permission filter

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The filter configuration

displayName
required
string

The display name of the filter.

value
required
string

The actual value of the filter.

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Delete a permission filter

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Get a permission filter

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "account": "string",
  • "displayName": "string",
  • "id": "string",
  • "type": "string",
  • "value": "string"
}

Update a permission filter

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The filter configuration

displayName
required
string

The display name of the filter.

value
required
string

The actual value of the filter.

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Get the targets of a permission filter

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set the targets of a permission filter

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The entities to which the filter must be applied.

targetedGroups
Array of strings unique

The ids of the groups targeted by the filter.

targetedUsers
Array of strings unique

The ids of the users targeted by the filter.

Responses

Request samples

Content type
application/json
{
  • "targetedGroups": [
    ],
  • "targetedUsers": [
    ]
}

Get the users of a permission filter

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set the users of a permission filter

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The users to set the permission on.

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Get all the reporting filters

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "filters": [
    ]
}

Create a reporting filter

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The filter configuration

displayName
required
string

The display name of the filter.

value
required
string

The actual value of the filter.

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Delete a reporting filter

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Get a reporting filter

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "account": "string",
  • "displayName": "string",
  • "id": "string",
  • "type": "string",
  • "value": "string"
}

Update a reporting filter

Authorizations:
v8
path Parameters
filterId
required
string

The unique identifier of a filter. This id is generated by the server when creating a filter.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The filter configuration

displayName
required
string

The display name of the filter.

value
required
string

The actual value of the filter.

Responses

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Get the filter service status

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Groups API - Version 15

Gets all groups for account.

Authorizations:
v8
query Parameters
org
required
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "groups": [
    ]
}

Health check for the groups service

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get the groups service status

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get a group.

Authorizations:
v8
path Parameters
groupId
required
string

The unique identifier of a group.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "account": "string",
  • "filters": [
    ],
  • "groupId": "string",
  • "reports": [
    ]
}

Gets the data level filters that apply to the specified group.

Authorizations:
v8
path Parameters
groupId
required
string

The unique identifier of a group.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "filters": [
    ]
}

Set the filters that will be applied to the specified group's query

Authorizations:
v8
path Parameters
groupId
required
string

The unique identifier of a group.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The filters that will be applied to the user. Must be a persisted filter ID

Array
id
required
boolean

Whether the value is a persisted filter ID or a filter value

value
required
string

The actual value of the filter.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Gets the reports that the specified group can access.

Authorizations:
v8
path Parameters
groupId
required
string

The unique identifier of a group.

query Parameters
includeConfig
boolean
Default: true

Whether to include the detailed configuration of the report in the response.

org
string

The unique identifier of a user.

Responses

Response samples

Content type
application/json
{
  • "reports": [
    ]
}

Set which reports the specified group can access.

Authorizations:
v8
path Parameters
groupId
required
string

The unique identifier of a group.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The IDs of the reports the user can access

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Metrics API - Version 15

Get all the metrics

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "metricResponses": [
    ]
}

Health check for the metrics service

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get the metrics service status

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get a metric

Authorizations:
v8
path Parameters
metricName
required
string

metricName

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "availableInVisit": true,
  • "displayName": "string",
  • "eventTypes": [
    ],
  • "higherIsBetter": true,
  • "metricName": "string",
  • "percentage": true,
  • "summable": true,
  • "type": "string"
}

Reader Account API - Version 15

Get the amount of compute credits used by a Snowflake reader account within a date range

Authorizations:
v8
query Parameters
from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

org
string

The name of the organization (Coveo Cloud V2 only)

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

Responses

Response samples

Content type
application/json
{
  • "creditsUsed": 0
}

Get the details of the active network policy for a Snowflake reader account

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "allowedIpAddresses": [
    ],
  • "blockedIpAddresses": [
    ]
}

Set the details of the active network policy for a Snowflake reader account

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

Snowflake user details.

allowedIpAddresses
required
Array of strings unique

The set of IPv4 addresses (with optional subnets) that are allowed access to the Snowflake account.

blockedIpAddresses
Array of strings unique

The set of IPv4 addresses (with optional subnets) that are denied access to the Snowflake account.

Responses

Request samples

Content type
application/json
{
  • "allowedIpAddresses": [
    ],
  • "blockedIpAddresses": [
    ]
}

Delete Snowflake reader account

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Retrieve Snowflake reader account state

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "snowflakeReaderAccountStatus": "AVAILABLE"
}

Retrieve Snowflake reader account endpoint

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "endpoint": "string"
}

Create a reader account

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "allowedMethods": [
    ],
  • "cookies": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "entity": { },
  • "entityTag": {
    },
  • "headers": {
    },
  • "language": {
    },
  • "lastModified": "2019-08-24T14:15:22Z",
  • "length": 0,
  • "links": [
    ],
  • "location": "http://example.com",
  • "mediaType": {
    },
  • "metadata": {
    },
  • "status": 0,
  • "statusInfo": {
    },
  • "stringHeaders": {
    }
}

Get the details for all users from a Snowflake reader account

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new user within a Snowflake reader account

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

Snowflake user details.

email
required
string

The user's e-mail, where password setup and reset URLs will be sent

username
required
string

The username, which will be used when logging into the Snowflake account

daysToExpiry
integer <int32>

The number of days before the user expiration, if not defined, the user will never expire.

Responses

Request samples

Content type
application/json
{
  • "daysToExpiry": 0,
  • "email": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "daysToExpiry": 0,
  • "email": "string",
  • "username": "string"
}

Delete a user from a Snowflake reader account

Authorizations:
v8
path Parameters
snowflakeUser
required
string

The login name for the Snowflake user.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Get the details for a specific user from a Snowflake reader account

Authorizations:
v8
path Parameters
snowflakeUser
required
string

The login name for the Snowflake user.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "daysToExpiry": 0,
  • "email": "string",
  • "username": "string"
}

Change the expiration time of a Snowflake reader account user

Authorizations:
v8
path Parameters
snowflakeUser
required
string

The login name for the Snowflake user.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

Snowflake user details.

daysToExpiry
integer <int32>

The number of days before the user expiration.

Responses

Request samples

Content type
application/json
{
  • "daysToExpiry": 0
}

Reset a user's password in a Snowflake reader account

Authorizations:
v8
path Parameters
snowflakeUser
required
string

The login name for the Snowflake user.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Reports API - Version 15

Get the persisted reports of one or all types

Authorizations:
v8
query Parameters
includeConfig
boolean
Default: true

Whether to include the detailed configuration of the report in the response.

org
string

The name of the organization (Coveo Cloud V2 only)

type
string
Enum: "DASHBOARD" "EXPLORER" "EXPLORER,DASHBOARD"

The type of the report. Must be either 'explorer' or 'dashboard'.

Responses

Response samples

Content type
application/json
{
  • "reports": [
    ]
}

Create a report

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The report configuration

allAnalyticsViewer
required
boolean

Whether the report should be available to all analytics viewer.

required
object

The configuration of the report. Must be a json.

displayName
required
string

The display name of the report.

type
required
string
Enum: "DASHBOARD" "EXPLORER"

The type of the report. Must be either 'explorer' or 'dashboard'.

filters
Array of strings unique

The ids of the persisted filters associated with the report.

Responses

Request samples

Content type
application/json
{
  • "allAnalyticsViewer": true,
  • "configuration": {
    },
  • "displayName": "string",
  • "filters": [
    ],
  • "type": "DASHBOARD"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Health check for the reports service

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get the reports service status

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get metadata about available report templates

Authorizations:
v8
query Parameters
includeMetadata
boolean

Whether to include metadata about the report template.

org
string

The name of the organization (Coveo Cloud V2 only)

type
required
string
Default: "DASHBOARD"
Enum: "DASHBOARD" "EXPLORER"

The type of the report. Must be either 'explorer' or 'dashboard'.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a report template

Authorizations:
v8
path Parameters
templateId
required
string

The unique identifier of a template.

query Parameters
includeMetadata
boolean

Whether to include metadata about the report template.

org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete a report

Authorizations:
v8
path Parameters
reportId
required
string

The unique identifier of a report. This id is generated by the server when creating a report.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Get a report

Authorizations:
v8
path Parameters
reportId
required
string

The unique identifier of a report. This id is generated by the server when creating a report.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

tz
string

Timezone used for calculations.

Responses

Response samples

Content type
application/json
{
  • "account": "string",
  • "allAnalyticsViewer": true,
  • "configuration": {
    },
  • "displayName": "string",
  • "filters": [
    ],
  • "id": "string",
  • "type": "string"
}

Update a report

Authorizations:
v8
path Parameters
reportId
required
string

The unique identifier of a report. This id is generated by the server when creating a report.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The report configuration

allAnalyticsViewer
required
boolean

Whether the report should be available to all analytics viewer.

required
object

The configuration of the report. Must be a json.

displayName
required
string

The display name of the report.

type
required
string
Enum: "DASHBOARD" "EXPLORER"

The type of the report. Must be either 'explorer' or 'dashboard'.

filters
Array of strings unique

The ids of the persisted filters associated with the report.

Responses

Request samples

Content type
application/json
{
  • "allAnalyticsViewer": true,
  • "configuration": {
    },
  • "displayName": "string",
  • "filters": [
    ],
  • "type": "DASHBOARD"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Get the users and groups who can view a report

Authorizations:
v8
path Parameters
reportId
required
string

The unique identifier of a report. This id is generated by the server when creating a report.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "accessType": "PUBLIC",
  • "allowedGroups": [
    ],
  • "allowedUsers": [
    ]
}

Set the users and groups who are allowed to view a report

Authorizations:
v8
path Parameters
reportId
required
string

The unique identifier of a report. This id is generated by the server when creating a report.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The entities that are allowed to view the report.

accessType
string
Enum: "PUBLIC" "PRIVATE" "PUBLIC" "PRIVATE"

Whether the report is public or private. Allowed values are 'PUBLIC', 'PRIVATE'.

allowedGroups
Array of strings unique

The ids of the groups allowed to access the report.

allowedUsers
Array of strings unique

The ids of the users allowed to access the report.

Responses

Request samples

Content type
application/json
{
  • "accessType": "PUBLIC",
  • "allowedGroups": [
    ],
  • "allowedUsers": [
    ]
}

Get the users who can view a report

Authorizations:
v8
path Parameters
reportId
required
string

The unique identifier of a report. This id is generated by the server when creating a report.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "access": "PUBLIC",
  • "allowedUsers": [
    ]
}

Set the users who are allowed to view a report

Authorizations:
v8
path Parameters
reportId
required
string

The unique identifier of a report. This id is generated by the server when creating a report.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The IDs of the allowed users.

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Secure Data Sharing API - Version 15

Removes a Snowflake account from Secure Data Sharing

Authorizations:
v8
query Parameters
accountLocator
required
string

The Snowflake account locator.

org
string

The name of the organization (Coveo Cloud V2 only)

snowflakeRegion
required
string

The Snowflake region.

Responses

Retrieve Snowflake accounts currently associated in Secure Data Sharing

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a Snowflake account to Secure Data Sharing

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json

The Snowflake account to which data should be shared.

accountLocator
required
string

The Snowflake account locator.

snowflakeRegion
required
string

The Snowflake region identifier.

Responses

Request samples

Content type
application/json
{
  • "accountLocator": "string",
  • "snowflakeRegion": "string"
}

Retrieve allowed Snowflake regions for Secure Data Sharing

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "primaryRegion": "string",
  • "secondaryRegions": [
    ]
}

Statistics API - Version 15

Get metrics combined with dimensions for a date range

There is one value of each metric for every possible dimension combination.

Authorizations:
v8
query Parameters
asc
boolean
Default: true

Whether to sort by ascending order.

bindOnLastSearch
boolean
Default: true

bindOnLastSearch

d
required
Array of strings

The dimensions to fetch.

f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

fm
Array of strings

The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND operator.

format
string
Default: "JSON"
Enum: "JSON" "CSV" "JSON,CSV"

The format of the response. Default is JSON.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

includeMetadata
boolean
Default: true

Whether to include metadata regarding the results (total count and unique counts, if applicable).

m
required
Array of strings

The metrics to fetch.

n
integer <int32>

The number of results to include in a page.

org
string

The name of the organization (Coveo Cloud V2 only)

p
integer <int32>

The response's page to access, starting at 1.

s
string

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.

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

tz
string
Default: "Z"

Timezone used for calculations.

Responses

Response samples

Content type
{
  • "combinations": [
    ],
  • "totalNumberOfResults": 0,
  • "uniqueCounts": {
    }
}

Get global data for each metric for a date range

Global data contain the total, the daily peak and the daily average.

Authorizations:
v8
query Parameters
bindOnLastSearch
boolean
Default: true

bindOnLastSearch

d
Array of strings

The dimensions to fetch. Required when the Activity metric is requested as it has to be based on a dimension.

f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

i
string
Default: "DAY"
Enum: "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" … 1 more

The interval on which data will be grouped. Default value is DAY.

m
required
Array of strings

The metrics to fetch.

org
string

The name of the organization (Coveo Cloud V2 only)

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

tz
string
Default: "Z"

Timezone used for calculations.

Responses

Response samples

Content type
application/json
{
  • "globalDatas": {
    }
}

Get graph data points for the metrics for a date range

There is one data point per interval per metric. The interval can be specified with the 'i' query parameter.

Authorizations:
v8
query Parameters
bindOnLastSearch
boolean
Default: true

bindOnLastSearch

f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

i
string
Default: "DAY"
Enum: "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" … 1 more

The interval on which data will be grouped. Default value is DAY.

m
required
Array of strings

The metrics to fetch.

org
string

The name of the organization (Coveo Cloud V2 only)

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

tz
string
Default: "Z"

Timezone used for calculations.

Responses

Response samples

Content type
application/json
{
  • "dataPoints": [
    ],
  • "stats": {
    },
  • "totals": {
    }
}

Health check for the statistics service

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Cancel the execution of a query

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.

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Get the statistics service status

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get trends of a metric combined with dimensions for a date range

There is one value of each metric for every possible dimension combination.

Authorizations:
v8
query Parameters
asc
boolean
Default: true

Whether to sort by ascending order.

bindOnLastSearch
boolean
Default: true

bindOnLastSearch

d
required
Array of strings

The dimensions to fetch.

f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

fm
Array of strings

The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND operator.

format
string
Default: "JSON"
Enum: "JSON" "CSV" "JSON,CSV"

The format of the response. Default is JSON.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

includeMetadata
boolean
Default: true

Whether to include metadata regarding the results (total count and unique counts, if applicable).

m
required
Array of strings

The metrics to fetch.

n
integer <int32>

The number of results to include in a page.

org
string

The name of the organization (Coveo Cloud V2 only)

p
integer <int32>

The response's page to access, starting at 1.

previousFrom
string

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.

previousTo
string

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.

s
string

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.

t
required
Array of strings

The trends to caculate.

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

tz
string
Default: "Z"

Timezone used for calculations.

Responses

Response samples

Content type
{
  • "combinations": [
    ],
  • "totalNumberOfResults": 0,
  • "uniqueCounts": {
    }
}

Get the details of the visits matching the specified criteria

Authorizations:
v8
query Parameters
asc
boolean
Default: false

Whether to sort by ascending order.

d
Array of strings

The dimensions to fetch.

f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

fn
Array of strings

The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

hideEventFilters
Array of strings

Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator.

includeMetadata
boolean
Default: true

Whether to include metadata regarding the results (total count and unique counts, if applicable).

n
integer <int32>

The number of results to include in a page.

org
string

The name of the organization (Coveo Cloud V2 only)

p
integer <int32>

The response's page to access, starting at 1.

s
string
Default: "eventDatetime"

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.

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

tz
string
Default: "Z"

Timezone used for calculations.

Responses

Response samples

Content type
application/json
{
  • "totalNumberOfVisits": 0,
  • "visits": [
    ]
}

Force a visit view update

Global data contain the total, the daily peak and the daily average.

Authorizations:
v8
query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Get graph data points for visit based metrics for a date range

There is one data point per interval per metric. The interval can be specified with the 'i' query parameter.

Authorizations:
v8
query Parameters
f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

fn
Array of strings

The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

hideEventFilters
Array of strings

Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator.

i
string
Default: "DAY"
Enum: "MINUTE" "HOUR" "DAY" "WEEK" "MONTH" … 1 more

The interval on which data will be grouped. Default value is DAY.

m
required
Array of strings

The metrics to fetch.

org
string

The name of the organization (Coveo Cloud V2 only)

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

tz
string
Default: "Z"

Timezone used for calculations.

Responses

Response samples

Content type
application/json
{
  • "dataPoints": [
    ],
  • "stats": {
    },
  • "totals": {
    }
}

Get the metrics based on the visits matching the specified criteria

Authorizations:
v8
query Parameters
f
Array of strings

The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.

fn
Array of strings

The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.

from
required
string

The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

hideEventFilters
Array of strings

Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator.

m
required
Array of strings

The metrics to fetch.

org
string

The name of the organization (Coveo Cloud V2 only)

to
required
string

The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'

tz
string
Default: "Z"

Timezone used for calculations.

Responses

Response samples

Content type
application/json
{
  • "globalDatas": {
    }
}

Users API - Version 15

Health check for the users service

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get the users service status

Authorizations:
v8

Responses

Response samples

Content type
application/json
{ }

Get a user

Authorizations:
v8
path Parameters
userId
required
string

The unique identifier of a user.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "account": "string",
  • "filters": [
    ],
  • "reports": [
    ],
  • "userId": "string"
}

Get the data level filters that apply to a user

Authorizations:
v8
path Parameters
userId
required
string

The unique identifier of a user.

query Parameters
includeGroups
boolean
Default: false

Whether to include the values inherited from a user's groups in the response.

org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "filters": [
    ]
}

Set the filters that will be applied to a user query

Authorizations:
v8
path Parameters
userId
required
string

The unique identifier of a user.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Request Body schema: application/json
required

The filters that will be applied to the user. Must be a persisted filter ID

Array
id
required
boolean

Whether the value is a persisted filter ID or a filter value

value
required
string

The actual value of the filter.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get the reports that a user can access

Authorizations:
v8
path Parameters
userId
required
string

The unique identifier of a user.

query Parameters
includeConfig
boolean
Default: true

Whether to include the detailed configuration of the report in the response.

includeGroups
boolean
Default: false

Whether to include the values inherited from a user's groups in the response.

org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "reports": [
    ]
}

Set which reports a user can access

Authorizations:
v8
path Parameters
userId
required
string

The unique identifier of a user.

query Parameters
org
string

The unique identifier of a user.

Request Body schema: application/json
required

The IDs of the reports the user can access

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

User Statistics API - Version 15

Delete the user data

Authorizations:
v8
path Parameters
userId
required
string

The unique identifier of a user.

query Parameters
org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "account": "string",
  • "message": "string",
  • "userId": "string"
}

Get the stats of a user

Authorizations:
v8
path Parameters
userId
required
string

The unique identifier of a user.

query Parameters
cached
string

cached

org
string

The name of the organization (Coveo Cloud V2 only)

Responses

Response samples

Content type
application/json
{
  • "account": "string",
  • "stats": {
    },
  • "userId": "string"
}