API docs by Redocly

Activity API (v1)

Activities

List activity facets

Lists activity facets matching the specified time interval and filters in a Coveo Cloud organization.

Required privilege: Activities - View

Privilege required

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

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

query Parameters
from
string <date-time>

The beginning of the date range, in ISO 8601 format, for which to list activity facets. If not specified, the parameter will be set as the current date and time.

to
string <date-time>

The end of the date range, in ISO 8601 format, for which to list activity facets.
The end range must be within 31 days of the beginning range.
Example: 2018-05-23T23:36:30.589Z

Request Body schema: application/json
required
operations
Array of strings
Items Enum: "APPLY" "ARCHIVE" "ARCHIVE_WARNING" "BACKUP" "CHANGE_ONLINE" … 51 more

The retrieved operation activity facet values.

organizationIds
Array of strings

The retrieved organization ID activity facet values. For internal use only.
Example: ["mycoveocloudorganizationg8tp8wu3", "anotherorganizationgbg4hy"]

resourceIds
Array of strings

The retrieved resource ID activity facet values.
Example: ["mycoveocloudorganizationg8tp8wu3-qp2fnxukqw7voteaiahlxfkf7i", "mycoveocloudorganizationg8tp8wu3-rnj3eisk4as63kx7zc4ch4keja", "MAPPING_EXTENSION"]

resourceTypes
Array of strings

The retrieved resource type activity facet values.
Example: ["EXPORTS", "SECURITY_PROVIDER"]

resultTypes
Array of strings
Items Enum: "SUCCESS" "ERROR" "ABORT"

The retrieved result type activity facet values.

sections
Array of strings
Items Enum: "CONTENT" "COMMERCE" "SEARCH" "ANALYTICS" "ORGANIZATION" … 2 more

The retrieved section activity facet values.

states
Array of strings
Items Enum: "NOT_EXECUTED" "EXECUTING" "PAUSED" "EXECUTED"

The retrieved state activity facet values.

Responses

Request samples

Content type
application/json
{
  • "operations": [
    ],
  • "organizationIds": [
    ],
  • "resourceIds": [
    ],
  • "resourceTypes": [
    ],
  • "resultTypes": [
    ],
  • "sections": [
    ],
  • "states": [
    ]
}

Get latest activities for a resource id of an organization based on a facet model.

Privilege required ``` {"owner":"PLATFORM","targetDomain":"ACTIVITIES","type":"VIEW","targetId":"*"} ```
Authorizations:
oauth2
path Parameters
organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

query Parameters
page
integer <int32>
Default: 0

The 0-based index number of the page of activities to retrieve.
Minimum: 0
Default: 0

perPage
integer <int32>
Default: 10

The maximum number of activities to list per page.
Minimum: 0
Default: 100

Request Body schema: application/json
required
operations
Array of strings
Items Enum: "APPLY" "ARCHIVE" "ARCHIVE_WARNING" "BACKUP" "CHANGE_ONLINE" … 51 more

The retrieved operation activity facet values.

organizationIds
Array of strings

The retrieved organization ID activity facet values. For internal use only.
Example: ["mycoveocloudorganizationg8tp8wu3", "anotherorganizationgbg4hy"]

resourceIds
Array of strings

The retrieved resource ID activity facet values.
Example: ["mycoveocloudorganizationg8tp8wu3-qp2fnxukqw7voteaiahlxfkf7i", "mycoveocloudorganizationg8tp8wu3-rnj3eisk4as63kx7zc4ch4keja", "MAPPING_EXTENSION"]

resourceTypes
Array of strings

The retrieved resource type activity facet values.
Example: ["EXPORTS", "SECURITY_PROVIDER"]

resultTypes
Array of strings
Items Enum: "SUCCESS" "ERROR" "ABORT"

The retrieved result type activity facet values.

sections
Array of strings
Items Enum: "CONTENT" "COMMERCE" "SEARCH" "ANALYTICS" "ORGANIZATION" … 2 more

The retrieved section activity facet values.

states
Array of strings
Items Enum: "NOT_EXECUTED" "EXECUTING" "PAUSED" "EXECUTED"

The retrieved state activity facet values.

Responses

Request samples

Content type
application/json
{
  • "operations": [
    ],
  • "organizationIds": [
    ],
  • "resourceIds": [
    ],
  • "resourceTypes": [
    ],
  • "resultTypes": [
    ],
  • "sections": [
    ],
  • "states": [
    ]
}

List operation types

Lists operation types available in a Coveo Cloud organization.

Required privilege: Activities - View

Privilege required

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

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Responses

List activities

Retrieves a page of activities matching the specified time interval and filters in the target organization.

Required privilege: Activities - View

Privilege required

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

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

query Parameters
from
string <date-time>

The beginning of the date range, in ISO 8601 format, for which to list activities. If not specified, the parameter will be set as the current date and time.
The end range must be within 31 days of the beginning range.
Example: 2018-05-22T23:36:30.589Z

page
integer <int32>
Default: 0

The 0-based index number of the page of activities to retrieve.
Minimum: 0
Default: 0

perPage
integer <int32>
Default: 100

The maximum number of activities to list per page.
Minimum: 0
Default: 100

to
string <date-time>

The end of the date range, in ISO 8601 format, for which to list activities.
The end range must be within 31 days of the beginning range.
Example: 2018-05-23T23:36:30.589Z

Request Body schema: application/json
required
operations
Array of strings
Items Enum: "APPLY" "ARCHIVE" "ARCHIVE_WARNING" "BACKUP" "CHANGE_ONLINE" … 51 more

The retrieved operation activity facet values.

organizationIds
Array of strings

The retrieved organization ID activity facet values. For internal use only.
Example: ["mycoveocloudorganizationg8tp8wu3", "anotherorganizationgbg4hy"]

resourceIds
Array of strings

The retrieved resource ID activity facet values.
Example: ["mycoveocloudorganizationg8tp8wu3-qp2fnxukqw7voteaiahlxfkf7i", "mycoveocloudorganizationg8tp8wu3-rnj3eisk4as63kx7zc4ch4keja", "MAPPING_EXTENSION"]

resourceTypes
Array of strings

The retrieved resource type activity facet values.
Example: ["EXPORTS", "SECURITY_PROVIDER"]

resultTypes
Array of strings
Items Enum: "SUCCESS" "ERROR" "ABORT"

The retrieved result type activity facet values.

sections
Array of strings
Items Enum: "CONTENT" "COMMERCE" "SEARCH" "ANALYTICS" "ORGANIZATION" … 2 more

The retrieved section activity facet values.

states
Array of strings
Items Enum: "NOT_EXECUTED" "EXECUTING" "PAUSED" "EXECUTED"

The retrieved state activity facet values.

Responses

Request samples

Content type
application/json
{
  • "operations": [
    ],
  • "organizationIds": [
    ],
  • "resourceIds": [
    ],
  • "resourceTypes": [
    ],
  • "resultTypes": [
    ],
  • "sections": [
    ],
  • "states": [
    ]
}

List resources and operations

Lists resource types and their corresponding operations

Privilege required

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

Responses

List resource types

Lists resource types available in a Coveo Cloud organization.

Required privilege: Activities - View

Privilege required

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

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Responses

Show activity

Shows an activity in a Coveo Cloud organization.

Required privilege: Activities - View

Privilege required

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

The unique identifier of the target activity.
Example: 128a706128d54btm98df8a98015301be

organizationId
required
string

The unique identifier of the target organization.
Example: mycoveocloudv2organizationg8tp8wu3

Responses