{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Metadata 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": "Metadata",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve Metadata Report for a Source",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/metadata",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "sourceId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Optional filter string. Must be at least 2 characters long to be applied."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query"
              },
              {
                "name": "order",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\nAND\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE_METADATA\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Create Metadata Report for a Source",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/metadata",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "sourceId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\nAND\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE_METADATA\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get the Status of Metadata Reports for a Source",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/metadata/status",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "sourceId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\nAND\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE_METADATA\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        }
      ]
    }
  ],
  "bundled": true
}