{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Limits 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": "Limits",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Manually Reset Limit Statuses for a Specific Section and Limit Key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/limits/reset/:sectionName/:limitKey",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "sectionName",
                "value": "",
                "type": "path",
                "description": "The name of the target license section.</br>**Example:** `content`"
              },
              {
                "name": "limitKey",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [limit](https://docs.coveo.com/en/262/) status to show.<br>**Example:**`pushApiMaximumDailyDocumentLimit`"
              }
            ]
          },
          "docs": "Admin operation to manually trigger the reset job for a specific limit. This only resets LimitStatus last updated before today. "
        },
        {
          "info": {
            "name": "Show Organization Limits and Their Statuses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/limits",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "limitType",
                "value": "",
                "type": "query",
                "description": "The type of limit you are wishing to retrieve."
              }
            ]
          },
          "docs": "Shows an [organization's](https://docs.coveo.com/en/185/) [limits](https://docs.coveo.com/en/262/) and their statuses.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "List Section Limits and Their Statuses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/limits/:sectionName",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "sectionName",
                "value": "",
                "type": "path",
                "description": "The name of the target license section.</br>**Example:** `content`"
              }
            ]
          },
          "docs": "Shows [limits](https://docs.coveo.com/en/262/) and their statuses for a specified license section of an [organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Show Specific Limit Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/limits/:sectionName/:limitKey",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "sectionName",
                "value": "",
                "type": "path",
                "description": "The name of the target license section.</br>**Example:** `content`"
              },
              {
                "name": "limitKey",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [limit](https://docs.coveo.com/en/262/) status to show.<br>**Example:**`pushApiMaximumDailyDocumentLimit`"
              }
            ]
          },
          "docs": "Shows the status of a specific [limit](https://docs.coveo.com/en/262/) in an [organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Show Limit History",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/limits/:sectionName/:limitKey/history",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "sectionName",
                "value": "",
                "type": "path",
                "description": "The name of the target license section.</br>**Example:** `content`"
              },
              {
                "name": "limitKey",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [limit](https://docs.coveo.com/en/262/) status to show.<br>**Example:**`pushApiMaximumDailyDocumentLimit`"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "The beginning of the date range for which to show limit history in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.</br>**Example:**`2022-05-08T01:30:00.000-05:00`"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "The ending of the date range for which to show limit history in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.</br>**Example:**`2022-05-10T01:30:00.000-05:00`"
              }
            ]
          },
          "docs": "Shows the history of a specific [limit](https://docs.coveo.com/en/262/) for a given date range.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        }
      ]
    }
  ],
  "bundled": true
}