{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities License Metrics 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": "License Metrics",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists the Available Metrics for Reporting",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/searchusagemetrics/license/all",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The organization ID"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Lists the Available Metrics for Reporting"
        },
        {
          "info": {
            "name": "Lists the Available Metrics for Assignment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/searchusagemetrics/license/assignable",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The organization ID"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Lists the Available Metrics for Assignment"
        },
        {
          "info": {
            "name": "Gets Per-Day Values for a Specific License Metric",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/searchusagemetrics/license/daily/:metric",
            "params": [
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "The last day to report for"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "The first day to report for"
              },
              {
                "name": "metric",
                "value": "",
                "type": "path",
                "description": "The license metric to report on"
              },
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The organization ID"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Gets Per-Day Values for a Specific License Metric"
        },
        {
          "info": {
            "name": "Lists the in-Use Metrics for an Organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/searchusagemetrics/license/inUse",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The organization ID"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Lists the in-Use Metrics for an Organization"
        },
        {
          "info": {
            "name": "Gets Per-Day Values for a Specific License Metric",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/searchusagemetrics/license/monthly/:metric",
            "params": [
              {
                "name": "slidingWindow",
                "value": "",
                "type": "query",
                "description": "When appropriate, the size of the sliding window to use, in months. If this parameter is not specified the default sliding window for the metric will be used."
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "The last month to report for"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "The first month to report for"
              },
              {
                "name": "metric",
                "value": "",
                "type": "path",
                "description": "The license metric to report on"
              },
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The organization ID"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Gets Per-Day Values for a Specific License Metric"
        },
        {
          "info": {
            "name": "Gets Total Values for a Specific License Metric Over a Specified Month Range",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/searchusagemetrics/license/total/:metric",
            "params": [
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "The last month to report for"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "The first month to report for"
              },
              {
                "name": "metric",
                "value": "",
                "type": "path",
                "description": "The license metric to report on"
              },
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The organization ID"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Gets Total Values for a Specific License Metric Over a Specified Month Range"
        }
      ]
    }
  ],
  "bundled": true
}