{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities In-App 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": "In-App",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create InAppWidget",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/inappwidget",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              }
            ]
          },
          "docs": "Creates an InAppWidget in a [Coveo Cloud organization](https://docs.coveo.com/en/185). <br/><br/>**Required privilege:** Search Pages - Create<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"CREATE\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "Update InAppWidget",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/inappwidget/:pageID",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "pageID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the search page whose corresponding InAppWidget should be updated (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')."
              }
            ]
          },
          "docs": "Updates an InAppWidget in a [Coveo Cloud organization](https://docs.coveo.com/en/185). <br/><br/>**Required privilege:** Search Pages - Edit<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"EDIT\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "List InAppWidgets",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/inappwidgets",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The 'name' metadata value of the search page whose corresponding InAppWidget should be retrieved (e.g., 'mysearchpage')."
              }
            ]
          },
          "docs": "Lists all InAppWidgets in a [Coveo Cloud organization](https://docs.coveo.com/en/185/). <br/><br/>**Required privilege:** Search Pages - View<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"VIEW\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "List InAppWidgets by Ids",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/inappwidgets/ids",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              }
            ]
          },
          "docs": "lists InAppWidgets by ids in a [Coveo Cloud organization](https://docs.coveo.com/en/185/). <br/><br/>**Required privilege:** Search Pages - View<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"VIEW\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "List InAppWidgets by Project ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/inappwidgets/projectid",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/) (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "projectid",
                "value": "",
                "type": "query",
                "description": "The project id"
              }
            ]
          },
          "docs": "lists InAppWidgets by project id in a [Coveo Cloud organization](https://docs.coveo.com/en/185/). <br/><br/>**Required privilege:** Search Pages - View<br/><details><summary>Privilege required</summary>```{ \"owner\": \"SEARCH_API\", \"targetDomain\": \"SEARCH_PAGES\", \"type\": \"VIEW\", \"targetId\": \"*\" }```</details>"
        },
        {
          "info": {
            "name": "Get InAppWidget Loader",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationID/pages/:pageID/inappwidget/loader",
            "params": [
              {
                "name": "organizationID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud [organization](https://docs.coveo.com/en/185) whose InAppWidget loader should be retrieved (e.g., 'mycoveocloudv2organizationg8tp8wu3')."
              },
              {
                "name": "pageID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the search page whose corresponding InAppWidget loader should be retrieved (e.g., '12b627f9-e3aa-49db-a0f5-5c0c1392e59e')."
              },
              {
                "name": "access_token",
                "value": "",
                "type": "query",
                "description": "<p>An access token (e.g., [search token](https://docs.coveo.com/en/1346/) or API key) the loader should initialize the InAppWidget with.</p><p>If provided, this token:</p><ul><li>Must grant the **Allowed** [access level](https://docs.coveo.com/en/2818/) on the **Execute Queries** [domain](https://docs.coveo.com/en/2819/), and the **Push** access level on the **Analytics Data** domain in the target [organization](https://docs.coveo.com/en/185/).</li><li>Will completely override the search token configuration specified the InAppWidget.</li></ul>"
              }
            ]
          },
          "docs": "Retrieves the JavaScript code that can initialize a specific InAppWidget configured in a [Coveo Cloud organization](https://docs.coveo.com/en/185). <br/><br/>**Required privilege:** None<br/>"
        }
      ]
    }
  ],
  "bundled": true
}