{
"opencollection": "1.0.0",
"info": {
"name": "Coveo Activity Activities API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
"accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"items": [
{
"info": {
"name": "Activities",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Activities",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/activities/public",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "The 0-based index number of the page of activities to retrieve.**Minimum:** `0`**Default:** `0`"
},
{
"name": "perPage",
"value": "",
"type": "query",
"description": "The maximum number of activities to list per page.**Minimum:** `0`**Default:** `100`"
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The beginning of the date range, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) 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`"
},
{
"name": "to",
"value": "",
"type": "query",
"description": "The end of the date range, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) 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`"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Retrieves a page of [activities](https://docs.coveo.com/en/173/) matching the specified time interval and filters in the target [organization](https://docs.coveo.com/en/185/).**Required privilege:** Activities - View
Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get Latest Activities for a Resource ID of an Organization Based on a Facet Model.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/activities/latest",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "The 0-based index number of the page of activities to retrieve.**Minimum:** `0`**Default:** `0`"
},
{
"name": "perPage",
"value": "",
"type": "query",
"description": "The maximum number of activities to list per page.**Minimum:** `0`**Default:** `100`"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "List Activity Facets",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/activities/facets/public",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`"
},
{
"name": "from",
"value": "",
"type": "query",
"description": "The beginning of the date range, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format, for which to list [activity](https://docs.coveo.com/en/173/) facets. If not specified, the parameter will be set as the current date and time."
},
{
"name": "to",
"value": "",
"type": "query",
"description": "The end of the date range, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format, for which to list [activity](https://docs.coveo.com/en/173/) facets.The end range must be within 31 days of the beginning range.**Example:** `2018-05-23T23:36:30.589Z`"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Lists [activity](https://docs.coveo.com/en/173/) facets matching the specified time interval and filters in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).**Required privilege:** Activities - View
Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Show Activity",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/activities/:activityId",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`"
},
{
"name": "activityId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [activity](https://docs.coveo.com/en/173/).**Example:** `128a706128d54btm98df8a98015301be`"
}
]
},
"docs": "Shows an [activity](https://docs.coveo.com/en/173/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).**Required privilege:** Activities - View
Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "List Resource Types",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/activities/resourcetypes",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`"
}
]
},
"docs": "Lists [resource](https://docs.coveo.com/en/2820/) types available in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).**Required privilege:** Activities - View
Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "List Resources and Operations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/activities/resourcesandoperations",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
}
]
},
"docs": "Lists [resource](https://docs.coveo.com/en/2820/) types and their corresponding operations
Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "List Operation Types",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/activities/operationtypes",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`"
}
]
},
"docs": "Lists operation types available in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).**Required privilege:** Activities - View
Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
}
]
}
],
"bundled": true
}