{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Dimensions API - Version 14 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": "Dimensions API - Version 14",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get All the Custom Dimensions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v14/dimensions/custom",
            "params": [
              {
                "name": "includeOnlyParents",
                "value": "",
                "type": "query",
                "description": "This will filter out dimensions which are covered by others. Only parent/master dimensions will be output"
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              }
            ]
          },
          "docs": "This endpoint is deprecated and will be removed on October 1st, 2024."
        },
        {
          "info": {
            "name": "Create a Custom Dimension",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/v14/dimensions/custom",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "The name of the custom dimension. It should start with the 'c_' prefix. If not present, the prefix will be added automatically."
              },
              {
                "name": "event",
                "value": "",
                "type": "query",
                "description": "The types of event where this dimension will be added."
              },
              {
                "name": "updatePastEvents",
                "value": "",
                "type": "query",
                "description": "Whether to update the custom dimension in past events."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint is deprecated and will be removed on October 1st, 2024."
        },
        {
          "info": {
            "name": "Get a Custom Dimension",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v14/dimensions/custom/:apiName",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "name": "apiName",
                "value": "",
                "type": "path",
                "description": "Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension."
              }
            ]
          },
          "docs": "This endpoint is deprecated and will be removed on October 1st, 2024."
        },
        {
          "info": {
            "name": "Create or Edit a Custom Dimension",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/v14/dimensions/custom/:apiName",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "name": "apiName",
                "value": "",
                "type": "path",
                "description": "Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension."
              },
              {
                "name": "updatePastEvents",
                "value": "",
                "type": "query",
                "description": "Whether to update the custom dimension in past events."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint is deprecated and will be removed on October 1st, 2024."
        },
        {
          "info": {
            "name": "Get a Custom Dimension",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/v14/dimensions/custom/:apiName",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "name": "apiName",
                "value": "",
                "type": "path",
                "description": "Format must be `EVENT.DIMENSION` where EVENT is the event type and DIMENSION is the name of the dimension."
              }
            ]
          },
          "docs": "This endpoint is deprecated and will be removed on October 1st, 2024."
        },
        {
          "info": {
            "name": "Get a List of Dimensions That Have Data but Are Not Created Yet",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v14/dimensions/custom/:event/suggestions",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "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": "event",
                "value": "",
                "type": "path",
                "description": "The type of event for which to look for suggestions."
              },
              {
                "name": "includeValueSamples",
                "value": "",
                "type": "query",
                "description": "Whether value samples should be included in the response."
              },
              {
                "name": "depth",
                "value": "",
                "type": "query",
                "description": "The number of events to look at when getting suggestions. A larger depth means more suggestions but also slower performance."
              }
            ]
          },
          "docs": "This endpoint is deprecated and will be removed on October 1st, 2024."
        },
        {
          "info": {
            "name": "Health Check for the Custom Dimensions Service",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v14/dimensions/custom/monitoring/health"
          },
          "docs": "This endpoint is deprecated and will be removed on October 1st, 2024."
        },
        {
          "info": {
            "name": "Get the Custom Dimensions Service Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v14/dimensions/custom/status"
          },
          "docs": "This endpoint is deprecated and will be removed on October 1st, 2024."
        },
        {
          "info": {
            "name": "Get the Values for a Custom Dimension",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v14/dimensions/custom/:dimension/values",
            "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": "tz",
                "value": "",
                "type": "query",
                "description": "Timezone used for calculations."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "name": "dimension",
                "value": "",
                "type": "path",
                "description": "The dimensions to fetch."
              },
              {
                "name": "f",
                "value": "",
                "type": "query",
                "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator."
              },
              {
                "name": "p",
                "value": "",
                "type": "query",
                "description": "The response's page to access, starting at 1."
              },
              {
                "name": "n",
                "value": "",
                "type": "query",
                "description": "The number of result to include in a page."
              }
            ]
          },
          "docs": "This endpoint is deprecated and will be removed on October 1st, 2024."
        },
        {
          "info": {
            "name": "Get a Dimension",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v14/dimensions/:apiName"
          },
          "docs": "This endpoint is deprecated and will be removed on October 1st, 2024."
        },
        {
          "info": {
            "name": "Get All the Dimensions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v14/dimensions",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "name": "includeOnlyParents",
                "value": "",
                "type": "query",
                "description": "This will filter out dimensions which are covered by others. Only parent/master dimensions will be output"
              },
              {
                "name": "includeCustom",
                "value": "",
                "type": "query",
                "description": "Whether to include custom dimensions within the results."
              }
            ]
          },
          "docs": "This endpoint is deprecated and will be removed on October 1st, 2024."
        },
        {
          "info": {
            "name": "Health Check for the Dimensions Service",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v14/dimensions/monitoring/health"
          },
          "docs": "This endpoint is deprecated and will be removed on October 1st, 2024."
        },
        {
          "info": {
            "name": "Get the Dimensions Service Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v14/dimensions/status"
          },
          "docs": "This endpoint is deprecated and will be removed on October 1st, 2024."
        },
        {
          "info": {
            "name": "Get the Values for a Dimension",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/v14/dimensions/:dimension/values",
            "params": [
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "from"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'"
              },
              {
                "name": "tz",
                "value": "",
                "type": "query",
                "description": "Timezone used for calculations."
              },
              {
                "name": "org",
                "value": "",
                "type": "query",
                "description": "The name of the organization (Coveo Cloud V2 only)"
              },
              {
                "name": "dimension",
                "value": "",
                "type": "path",
                "description": "The dimensions to fetch."
              },
              {
                "name": "f",
                "value": "",
                "type": "query",
                "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator."
              },
              {
                "name": "p",
                "value": "",
                "type": "query",
                "description": "The response's page to access, starting at 1."
              },
              {
                "name": "n",
                "value": "",
                "type": "query",
                "description": "The number of result to include in a page."
              }
            ]
          },
          "docs": "This endpoint is deprecated and will be removed on October 1st, 2024."
        }
      ]
    }
  ],
  "bundled": true
}