{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Analytics API - Version 15 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": "Analytics API - Version 15",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Log Click Event via POST",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/v15/analytics/click",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "name": "visitor",
                "value": "",
                "type": "query",
                "description": "'''DEPRECATED''' The `clientId` parameter should be used instead of `visitorId` in the event payload to capture the visitor identifier. The unique identifier of the visitor. Unless `prioritizeVisitorParameter` is set to `true`, the service automatically attempts to override this query string parameter with the visitor cookie. If no `visitor` parameter is provided and the visitor cookie is absent, a new identifier is created and returned as the `visitorId` property in the response body, and as a visitor cookie."
              },
              {
                "name": "prioritizeVisitorParameter",
                "value": "",
                "type": "query",
                "description": "'''DEPRECATED''' The `clientId` parameter should be used instead of `visitorId` in the event payload to capture the visitor identifier. Whether to force the service to use the provided `visitor` query string parameter, rather than automatically attempting to override this parameter with the visitor cookie."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Logs a click event. Typically, when the end-user opens or previews a result, the search interface logs a click event."
        },
        {
          "info": {
            "name": "Log Custom Event via POST",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/v15/analytics/custom",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "name": "visitor",
                "value": "",
                "type": "query",
                "description": "'''DEPRECATED''' The `clientId` parameter should be used instead of `visitorId` in the event payload to capture the visitor identifier. The unique identifier of the visitor. Unless `prioritizeVisitorParameter` is set to `true`, the service automatically attempts to override this query string parameter with the visitor cookie. If no `visitor` parameter is provided and the visitor cookie is absent, a new identifier is created and returned as the `visitorId` property in the response body, and as a visitor cookie."
              },
              {
                "name": "prioritizeVisitorParameter",
                "value": "",
                "type": "query",
                "description": "'''DEPRECATED''' The `clientId` parameter should be used instead of `visitorId` in the event payload to capture the visitor identifier. Whether to force the service to use the provided `visitor` query string parameter, rather than automatically attempting to override this parameter with the visitor cookie."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Logs a custom event. Typically, when the end-user interacts with a page in a way that needs to be recorded, but that is neither a search, a click, or a view event (e.g., toggling the result list layout, changing end-user preferences), the page logs a custom event."
        },
        {
          "info": {
            "name": "Log Search Event via POST",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/v15/analytics/search",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "name": "visitor",
                "value": "",
                "type": "query",
                "description": "'''DEPRECATED''' The `clientId` parameter should be used instead of `visitorId` in the event payload to capture the visitor identifier. The unique identifier of the visitor. Unless `prioritizeVisitorParameter` is set to `true`, the service automatically attempts to override this query string parameter with the visitor cookie. If no `visitor` parameter is provided and the visitor cookie is absent, a new identifier is created and returned as the `visitorId` property in the response body, and as a visitor cookie."
              },
              {
                "name": "prioritizeVisitorParameter",
                "value": "",
                "type": "query",
                "description": "'''DEPRECATED''' The `clientId` parameter should be used instead of `visitorId` in the event payload to capture the visitor identifier. Whether to force the service to use the provided `visitor` query string parameter, rather than automatically attempting to override this parameter with the visitor cookie."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Logs a search event. Typically, when an end-user interacts with a search interface in a way that triggers a [query](https://docs.coveo.com/en/231/glossary/query) to the [Search API](https://docs.coveo.com/en/52/cloud-v2-developers/search-api) (e.g., submitting a query from the search box, selecting a [facet](https://docs.coveo.com/en/198/glossary/facet) value, etc.), the search interface logs a search event."
        },
        {
          "info": {
            "name": "Log Search Event Batch via POST",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/v15/analytics/searches",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "name": "visitor",
                "value": "",
                "type": "query",
                "description": "'''DEPRECATED''' The `clientId` parameter should be used instead of `visitorId` in the event payload to capture the visitor identifier. The unique identifier of the visitor. Unless `prioritizeVisitorParameter` is set to `true`, the service automatically attempts to override this query string parameter with the visitor cookie. If no `visitor` parameter is provided and the visitor cookie is absent, a new identifier is created and returned as the `visitorId` property in the response body, and as a visitor cookie."
              },
              {
                "name": "prioritizeVisitorParameter",
                "value": "",
                "type": "query",
                "description": "'''DEPRECATED''' The `clientId` parameter should be used instead of `visitorId` in the event payload to capture the visitor identifier. Whether to force the service to use the provided `visitor` query string parameter, rather than automatically attempting to override this parameter with the visitor cookie."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Logs one or more search events. Typically, when an end-user interacts with a search interface in a way that triggers a [query](https://docs.coveo.com/en/231/glossary/query) to the [Search API](https://docs.coveo.com/en/52/cloud-v2-developers/search-api) (e.g., submitting a query from the search box, selecting a [facet](https://docs.coveo.com/en/198/glossary/facet) value, etc.), the search interface logs a search event. Logging a batch of more than three items should generally be avoided, due to "
        },
        {
          "info": {
            "name": "Log View Event via POST",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/v15/analytics/view",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "name": "visitor",
                "value": "",
                "type": "query",
                "description": "'''DEPRECATED''' The `clientId` parameter should be used instead of `visitorId` in the event payload to capture the visitor identifier. The unique identifier of the visitor. Unless `prioritizeVisitorParameter` is set to `true`, the service automatically attempts to override this query string parameter with the visitor cookie. If no `visitor` parameter is provided and the visitor cookie is absent, a new identifier is created and returned as the `visitorId` property in the response body, and as a visitor cookie."
              },
              {
                "name": "prioritizeVisitorParameter",
                "value": "",
                "type": "query",
                "description": "'''DEPRECATED''' The `clientId` parameter should be used instead of `visitorId` in the event payload to capture the visitor identifier. Whether to force the service to use the provided `visitor` query string parameter, rather than automatically attempting to override this parameter with the visitor cookie."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Logs a view event. Although view events are not currently available for usage analytics reports, they are required to feed [Coveo Machine Learning](https://docs.coveo.com/en/188/glossary/coveo-machine-learning) [event recommendations](https://docs.coveo.com/en/1016/glossary/event-recommendations) [models](https://docs.coveo.com/en/1012/glossary/model). A page corresponding to an [item](https://docs.coveo.com/en/210/glossary/item) which should be considered as a possible candidate result for the "
        },
        {
          "info": {
            "name": "Collect GA-Style Events",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/v15/analytics/collect",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Collect GA-Style Events"
        },
        {
          "info": {
            "name": "Get Service Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/analytics/monitoring/health"
          },
          "docs": "Returns the status of the Usage Analytics Write service. Possible values are 'UP', 'unavailable' and 'degraded'."
        },
        {
          "info": {
            "name": "Get Service Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/analytics/status"
          },
          "docs": "This endpoint is exposed for backward compatibility reasons. Use `monitoring/health` instead. Returns the status of the Usage Analytics Write service. Possible values are 'online', 'unavailable' and 'degraded'."
        },
        {
          "info": {
            "name": "Get Current Visit",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/analytics/visit",
            "params": [
              {
                "name": "user",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the user performing the search event. If not provided, the username will be extracted from the token."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "name": "visitor",
                "value": "",
                "type": "query",
                "description": "'''DEPRECATED''' The `clientId` parameter should be used instead of `visitorId` in the event payload to capture the visitor identifier. The unique identifier of the visitor. Unless `prioritizeVisitorParameter` is set to `true`, the service automatically attempts to override this query string parameter with the visitor cookie. If no `visitor` parameter is provided and the visitor cookie is absent, a new identifier is created and returned as the `visitorId` property in the response body, and as a visitor cookie."
              },
              {
                "name": "clientId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the visitor. If a client id is provided, it is prioritized over any value passed for the visitor id parameter."
              },
              {
                "name": "prioritizeVisitorParameter",
                "value": "",
                "type": "query",
                "description": "'''DEPRECATED''' The `clientId` parameter should be used instead of `visitorId` in the event payload to capture the visitor identifier. Whether to force the service to use the provided `visitor` query string parameter, rather than automatically attempting to override this parameter with the visitor cookie."
              }
            ]
          },
          "docs": "Returns the current `visitId`, `visitorId` and `clientId`."
        },
        {
          "info": {
            "name": "Delete Visit Cookie",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/v15/analytics/visit"
          },
          "docs": "Deletes the current `visitorId` cookie. A new one will be generated during the next interaction with the service, which will also create a new `visitId`."
        }
      ]
    }
  ],
  "bundled": true
}