{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Data Health 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": "Data Health API - Version 15",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the Payload of an Event.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/datahealth/events/payload",
            "params": [
              {
                "name": "timestamp",
                "value": "",
                "type": "query",
                "description": "The timestamp of the event. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'"
              },
              {
                "name": "eventId",
                "value": "",
                "type": "query",
                "description": "The id of the event for which to return information."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ]
          },
          "docs": "Get the Payload of an Event."
        },
        {
          "info": {
            "name": "Get Problems About Events",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/datahealth/events/problems",
            "params": [
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'"
              },
              {
                "name": "eventType",
                "value": "",
                "type": "query",
                "description": "A set of event types for which the events will be returned."
              },
              {
                "name": "searchHub",
                "value": "",
                "type": "query",
                "description": "A set of search hubs for which the events will be returned."
              },
              {
                "name": "trackingId",
                "value": "",
                "type": "query",
                "description": "The tracking IDs for which the results should be returned."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The response's page to access, starting at 0."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of results to include in a page."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ]
          },
          "docs": "Get Problems About Events"
        },
        {
          "info": {
            "name": "Get Failed Instances for a Data Health Criterion",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/datahealth/criteria/failedInstances",
            "params": [
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'"
              },
              {
                "name": "criterionId",
                "value": "",
                "type": "query",
                "description": "The data health criterion for which the failed instances should be returned."
              },
              {
                "name": "group",
                "value": "",
                "type": "query",
                "description": "The group for which data health information should be returned."
              },
              {
                "name": "scopeValue",
                "value": "",
                "type": "query",
                "description": "The value of the criterion scope for which failed instances should be returned. For example, if the scope of a rule is 'EVENT', the scope value could be 'Click', 'Search', etc. The failed instances would contain sample events of the specified type."
              },
              {
                "name": "trackingId",
                "value": "",
                "type": "query",
                "description": "The tracking IDs for which the results should be returned."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The response's page to access, starting at 0."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of results to include in a page."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ]
          },
          "docs": "Get Failed Instances for a Data Health Criterion"
        },
        {
          "info": {
            "name": "Get Detailed Information About a Data Health Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/datahealth/groups/detail",
            "params": [
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'"
              },
              {
                "name": "group",
                "value": "",
                "type": "query",
                "description": "The group for which data health information should be returned."
              },
              {
                "name": "category",
                "value": "",
                "type": "query",
                "description": "The categories of rules for which data health should be displayed."
              },
              {
                "name": "feature",
                "value": "",
                "type": "query",
                "description": "The feature for which data health should be computed."
              },
              {
                "name": "trackingId",
                "value": "",
                "type": "query",
                "description": "The tracking IDs for which the results should be returned."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ]
          },
          "docs": "Get Detailed Information About a Data Health Group"
        },
        {
          "info": {
            "name": "Get a Listing of Data Health Groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/datahealth/groups",
            "params": [
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'"
              },
              {
                "name": "category",
                "value": "",
                "type": "query",
                "description": "The categories of rules for which data health should be displayed."
              },
              {
                "name": "feature",
                "value": "",
                "type": "query",
                "description": "The feature for which data health should be computed."
              },
              {
                "name": "trackingId",
                "value": "",
                "type": "query",
                "description": "The tracking IDs for which the results should be returned."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The response's page to access, starting at 0."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of results to include in a page."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "name": "showEmptyGroups",
                "value": "",
                "type": "query",
                "description": "Whether or not groups with zero event validated should be shown"
              }
            ]
          },
          "docs": "Get a Listing of Data Health Groups"
        },
        {
          "info": {
            "name": "Get the Data Health Overview",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/datahealth/overview",
            "params": [
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'"
              },
              {
                "name": "category",
                "value": "",
                "type": "query",
                "description": "The categories of rules for which data health should be displayed."
              },
              {
                "name": "feature",
                "value": "",
                "type": "query",
                "description": "The feature for which data health should be computed."
              },
              {
                "name": "trackingId",
                "value": "",
                "type": "query",
                "description": "The tracking IDs for which the results should be returned."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ]
          },
          "docs": "Get the Data Health Overview"
        },
        {
          "info": {
            "name": "Get the Data Health Service Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/datahealth/status"
          },
          "docs": "Get the Data Health Service Status"
        },
        {
          "info": {
            "name": "Get Health Information About Events",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/datahealth/events",
            "params": [
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'"
              },
              {
                "name": "clientId",
                "value": "",
                "type": "query",
                "description": "A set of client IDs for which the events will be returned."
              },
              {
                "name": "visitId",
                "value": "",
                "type": "query",
                "description": "A set of visit IDs for which the events will be returned."
              },
              {
                "name": "eventSource",
                "value": "",
                "type": "query",
                "description": "A set of event sources for which the events will be returned."
              },
              {
                "name": "eventType",
                "value": "",
                "type": "query",
                "description": "A set of event types for which the events will be returned."
              },
              {
                "name": "searchHub",
                "value": "",
                "type": "query",
                "description": "A set of search hubs for which the events will be returned."
              },
              {
                "name": "trackingId",
                "value": "",
                "type": "query",
                "description": "The tracking IDs for which the results should be returned."
              },
              {
                "name": "healthStatus",
                "value": "",
                "type": "query",
                "description": "A health status for which the events will be returned."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The response's page to access, starting at 0."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of results to include in a page."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ]
          },
          "docs": "Get Health Information About Events"
        },
        {
          "info": {
            "name": "List Facet Values for Event Browser",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v15/datahealth/facets",
            "params": [
              {
                "name": "facet",
                "value": "",
                "type": "query",
                "description": "The facet for which the values should be listed"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'"
              },
              {
                "name": "clientId",
                "value": "",
                "type": "query",
                "description": "A set of client IDs for which the events will be returned."
              },
              {
                "name": "visitId",
                "value": "",
                "type": "query",
                "description": "A set of visit IDs for which the events will be returned."
              },
              {
                "name": "eventSource",
                "value": "",
                "type": "query",
                "description": "A set of event sources for which the events will be returned."
              },
              {
                "name": "eventType",
                "value": "",
                "type": "query",
                "description": "A set of event types for which the events will be returned."
              },
              {
                "name": "searchHub",
                "value": "",
                "type": "query",
                "description": "A set of search hubs for which the events will be returned."
              },
              {
                "name": "trackingId",
                "value": "",
                "type": "query",
                "description": "The tracking IDs for which the results should be returned."
              },
              {
                "name": "healthStatus",
                "value": "",
                "type": "query",
                "description": "A health status for which the events will be returned."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ]
          },
          "docs": "List Facet Values for Event Browser"
        }
      ]
    }
  ],
  "bundled": true
}