{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Reports 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": "Reports API - Version 15",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the Persisted Reports of One or All Types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/reports",
            "params": [
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The type of the report. Must be either 'explorer' or 'dashboard'."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "name": "includeConfig",
                "value": "",
                "type": "query",
                "description": "Whether to include the detailed configuration of the report in the response."
              }
            ]
          },
          "docs": "Get the Persisted Reports of One or All Types"
        },
        {
          "info": {
            "name": "Create a Report",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/v15/reports",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a Report"
        },
        {
          "info": {
            "name": "Get a Report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/reports/:reportId",
            "params": [
              {
                "name": "reportId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a report. This id is generated by the server when creating a report."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "name": "tz",
                "value": "",
                "type": "query",
                "description": "Timezone used for calculations."
              }
            ]
          },
          "docs": "Get a Report"
        },
        {
          "info": {
            "name": "Update a Report",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/v15/reports/:reportId",
            "params": [
              {
                "name": "reportId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a report. This id is generated by the server when creating a report."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a Report"
        },
        {
          "info": {
            "name": "Delete a Report",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/v15/reports/:reportId",
            "params": [
              {
                "name": "reportId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a report. This id is generated by the server when creating a report."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ]
          },
          "docs": "Delete a Report"
        },
        {
          "info": {
            "name": "Get the Users and Groups Who Can View a Report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/reports/:reportId/access",
            "params": [
              {
                "name": "reportId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a report. This id is generated by the server when creating a report."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ]
          },
          "docs": "Get the Users and Groups Who Can View a Report"
        },
        {
          "info": {
            "name": "Set the Users and Groups Who Are Allowed to View a Report",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/v15/reports/:reportId/access",
            "params": [
              {
                "name": "reportId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a report. This id is generated by the server when creating a report."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set the Users and Groups Who Are Allowed to View a Report"
        },
        {
          "info": {
            "name": "Health Check for the Reports Service",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/reports/monitoring/health"
          },
          "docs": "Health Check for the Reports Service"
        },
        {
          "info": {
            "name": "Get the Reports Service Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/reports/status"
          },
          "docs": "Get the Reports Service Status"
        },
        {
          "info": {
            "name": "Get a Report Template",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/reports/templates/:templateId",
            "params": [
              {
                "name": "templateId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a template."
              },
              {
                "name": "includeMetadata",
                "value": "",
                "type": "query",
                "description": "Whether to include metadata about the report template."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ]
          },
          "docs": "Get a Report Template"
        },
        {
          "info": {
            "name": "Get Metadata About Available Report Templates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/reports/templates",
            "params": [
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "The type of the report. Must be either 'explorer' or 'dashboard'."
              },
              {
                "name": "includeMetadata",
                "value": "",
                "type": "query",
                "description": "Whether to include metadata about the report template."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ]
          },
          "docs": "Get Metadata About Available Report Templates"
        },
        {
          "info": {
            "name": "Get the Users Who Can View a Report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/reports/:reportId/users",
            "params": [
              {
                "name": "reportId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a report. This id is generated by the server when creating a report."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ]
          },
          "docs": "Get the Users Who Can View a Report"
        },
        {
          "info": {
            "name": "Set the Users Who Are Allowed to View a Report",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/v15/reports/:reportId/users",
            "params": [
              {
                "name": "reportId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a report. This id is generated by the server when creating a report."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set the Users Who Are Allowed to View a Report"
        }
      ]
    }
  ],
  "bundled": true
}