{ "info": { "_postman_id": "977d1605-7826-4153-a953-91dded6fa301", "name": "Coveo Activity Activities Statistics API - Version 14 API", "description": "API for Coveo Platform\n\nContact Support:\n Name: Coveo", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "lastUpdatedBy": "35240", "uid": "35240-977d1605-7826-4153-a953-91dded6fa301" }, "item": [ { "name": "v14", "item": [ { "name": "stats", "item": [ { "name": "combinedData", "item": [ { "name": "Get Metrics Combined with Dimensions for a Date Range", "id": "a26198c5-c315-4a72-ade0-c88de8815f40", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/stats/combinedData?m=&m=&from=&to=&tz=Z&d=Z&f=&f=&fm=&fm=&s=&p=&n=&asc=true&includeMetadata=true&format=JSON&bindOnLastSearch=true&org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "stats", "combinedData" ], "query": [ { "description": "(Required) The metrics to fetch.", "key": "m", "value": "" }, { "description": "(Required) The metrics to fetch.", "key": "m", "value": "" }, { "description": "(Required) The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "from", "value": "" }, { "description": "(Required) The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "to", "value": "" }, { "description": "Timezone used for calculations.", "key": "tz", "value": "Z" }, { "description": "Timezone used for calculations.", "key": "d", "value": "Z" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND operator.", "key": "fm", "value": "" }, { "description": "The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND operator.", "key": "fm", "value": "" }, { "description": "The field to order the results by. It must be a dimension, metric or custom dimension that was specified in the 'm' or the 'd' parameter.", "key": "s", "value": "" }, { "description": "The response's page to access, starting at 1.", "key": "p", "value": "" }, { "description": "The number of result to include in a page.", "key": "n", "value": "" }, { "description": "Whether to sort by ascending order.", "key": "asc", "value": "true" }, { "description": "Whether to include metadata regarding the results (total count and unique counts, if applicable).", "key": "includeMetadata", "value": "true" }, { "description": "The format of the response. Default is JSON.", "key": "format", "value": "JSON" }, { "description": "bindOnLastSearch", "key": "bindOnLastSearch", "value": "true" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024.\nThere is one value of each metric for every possible dimension combination." }, "response": [ { "id": "56871548-09cd-4c73-b60d-0198c470e452", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v14/stats/combinedData?m=&from=&to=&tz=Z&d=Z&f=&fm=&s=&p=&n=&asc=true&includeMetadata=true&format=JSON&bindOnLastSearch=true&org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "stats", "combinedData" ], "query": [ { "description": "(Required) The metrics to fetch.", "key": "m", "value": "" }, { "description": "(Required) The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "from", "value": "" }, { "description": "(Required) The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "to", "value": "" }, { "description": "Timezone used for calculations.", "key": "tz", "value": "Z" }, { "description": "Timezone used for calculations.", "key": "d", "value": "Z" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND operator.", "key": "fm", "value": "" }, { "description": "The field to order the results by. It must be a dimension, metric or custom dimension that was specified in the 'm' or the 'd' parameter.", "key": "s", "value": "" }, { "description": "The response's page to access, starting at 1.", "key": "p", "value": "" }, { "description": "The number of result to include in a page.", "key": "n", "value": "" }, { "description": "Whether to sort by ascending order.", "key": "asc", "value": "true" }, { "description": "Whether to include metadata regarding the results (total count and unique counts, if applicable).", "key": "includeMetadata", "value": "true" }, { "description": "The format of the response. Default is JSON.", "key": "format", "value": "JSON" }, { "description": "bindOnLastSearch", "key": "bindOnLastSearch", "value": "true" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"combinations\": [\n {\n \"ex939\": {}\n },\n {\n \"sunt80\": {}\n }\n ],\n \"uniqueCounts\": {\n \"laboris5f0\": {},\n \"Utc\": {}\n },\n \"totalNumberOfResults\": \"\"\n}", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-56871548-09cd-4c73-b60d-0198c470e452" } ], "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-a26198c5-c315-4a72-ade0-c88de8815f40" } ], "id": "ac2116a6-18d4-48f1-bcf9-51ee2996af85", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-ac2116a6-18d4-48f1-bcf9-51ee2996af85" }, { "name": "trends", "item": [ { "name": "Get Trends of a Metric Combined with Dimensions for a Date Range", "id": "8b9c6f3e-ce6a-46b3-a943-c8c9f5da45ee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/stats/trends?m=&m=&from=&to=&previousFrom=&previousTo=&tz=Z&d=Z&f=&f=&fm=&fm=&s=&p=&n=&asc=true&includeMetadata=true&format=JSON&bindOnLastSearch=true&t=&t=&org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "stats", "trends" ], "query": [ { "description": "(Required) The metrics to fetch.", "key": "m", "value": "" }, { "description": "(Required) The metrics to fetch.", "key": "m", "value": "" }, { "description": "(Required) The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "from", "value": "" }, { "description": "(Required) The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "to", "value": "" }, { "description": "The beginning date of the previous date range, when reporting trends. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'. If not specified, it will be the 'from' date minus the duration of the 'from'-'to' date range.", "key": "previousFrom", "value": "" }, { "description": "The end date of the previous date range, when reporting trends. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'. If not specified, it will be the 'to' date minus the duration of the 'from'-'to' date range.", "key": "previousTo", "value": "" }, { "description": "Timezone used for calculations.", "key": "tz", "value": "Z" }, { "description": "Timezone used for calculations.", "key": "d", "value": "Z" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND operator.", "key": "fm", "value": "" }, { "description": "The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND operator.", "key": "fm", "value": "" }, { "description": "The field to order the results by. It must be a dimension, metric or custom dimension that was specified in the 'm' or the 'd' parameter.", "key": "s", "value": "" }, { "description": "The response's page to access, starting at 1.", "key": "p", "value": "" }, { "description": "The number of result to include in a page.", "key": "n", "value": "" }, { "description": "Whether to sort by ascending order.", "key": "asc", "value": "true" }, { "description": "Whether to include metadata regarding the results (total count and unique counts, if applicable).", "key": "includeMetadata", "value": "true" }, { "description": "The format of the response. Default is JSON.", "key": "format", "value": "JSON" }, { "description": "bindOnLastSearch", "key": "bindOnLastSearch", "value": "true" }, { "description": "(Required) The trends to caculate.", "key": "t", "value": "" }, { "description": "(Required) The trends to caculate.", "key": "t", "value": "" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024.\nThere is one value of each metric for every possible dimension combination." }, "response": [ { "id": "7ab3f74d-e924-489b-95a7-71a9f2fb84a4", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v14/stats/trends?m=&from=&to=&previousFrom=&previousTo=&tz=Z&d=Z&f=&fm=&s=&p=&n=&asc=true&includeMetadata=true&format=JSON&bindOnLastSearch=true&t=&org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "stats", "trends" ], "query": [ { "description": "(Required) The metrics to fetch.", "key": "m", "value": "" }, { "description": "(Required) The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "from", "value": "" }, { "description": "(Required) The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "to", "value": "" }, { "description": "The beginning date of the previous date range, when reporting trends. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'. If not specified, it will be the 'from' date minus the duration of the 'from'-'to' date range.", "key": "previousFrom", "value": "" }, { "description": "The end date of the previous date range, when reporting trends. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'. If not specified, it will be the 'to' date minus the duration of the 'from'-'to' date range.", "key": "previousTo", "value": "" }, { "description": "Timezone used for calculations.", "key": "tz", "value": "Z" }, { "description": "Timezone used for calculations.", "key": "d", "value": "Z" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND operator.", "key": "fm", "value": "" }, { "description": "The field to order the results by. It must be a dimension, metric or custom dimension that was specified in the 'm' or the 'd' parameter.", "key": "s", "value": "" }, { "description": "The response's page to access, starting at 1.", "key": "p", "value": "" }, { "description": "The number of result to include in a page.", "key": "n", "value": "" }, { "description": "Whether to sort by ascending order.", "key": "asc", "value": "true" }, { "description": "Whether to include metadata regarding the results (total count and unique counts, if applicable).", "key": "includeMetadata", "value": "true" }, { "description": "The format of the response. Default is JSON.", "key": "format", "value": "JSON" }, { "description": "bindOnLastSearch", "key": "bindOnLastSearch", "value": "true" }, { "description": "(Required) The trends to caculate.", "key": "t", "value": "" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"combinations\": [\n {\n \"ex939\": {}\n },\n {\n \"sunt80\": {}\n }\n ],\n \"uniqueCounts\": {\n \"laboris5f0\": {},\n \"Utc\": {}\n },\n \"totalNumberOfResults\": \"\"\n}", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-7ab3f74d-e924-489b-95a7-71a9f2fb84a4" } ], "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-8b9c6f3e-ce6a-46b3-a943-c8c9f5da45ee" } ], "id": "47f72a45-8b08-4cdd-a31d-421e97242f4f", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-47f72a45-8b08-4cdd-a31d-421e97242f4f" }, { "name": "globalData", "item": [ { "name": "Get Global Data for Each Metric for a Date Range", "id": "1c2a360f-b8dd-45d0-aceb-579aaa4fc733", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/stats/globalData?m=&m=&from=&to=&tz=Z&d=&d=&f=&f=&i=DAY&bindOnLastSearch=true&org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "stats", "globalData" ], "query": [ { "description": "(Required) The metrics to fetch.", "key": "m", "value": "" }, { "description": "(Required) The metrics to fetch.", "key": "m", "value": "" }, { "description": "(Required) The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "from", "value": "" }, { "description": "(Required) The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "to", "value": "" }, { "description": "Timezone used for calculations.", "key": "tz", "value": "Z" }, { "description": "The dimensions to fetch. Required when the Activity metric is requested as it has to be based on a dimension.", "key": "d", "value": "" }, { "description": "The dimensions to fetch. Required when the Activity metric is requested as it has to be based on a dimension.", "key": "d", "value": "" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The interval on which data will be grouped. Default value is DAY.", "key": "i", "value": "DAY" }, { "description": "bindOnLastSearch", "key": "bindOnLastSearch", "value": "true" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024.\nGlobal data contain the total, the daily peak and the daily average." }, "response": [ { "id": "592343b4-a8af-41c8-848e-23426720d8c2", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v14/stats/globalData?m=&from=&to=&tz=Z&d=&f=&i=DAY&bindOnLastSearch=true&org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "stats", "globalData" ], "query": [ { "description": "(Required) The metrics to fetch.", "key": "m", "value": "" }, { "description": "(Required) The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "from", "value": "" }, { "description": "(Required) The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "to", "value": "" }, { "description": "Timezone used for calculations.", "key": "tz", "value": "Z" }, { "description": "The dimensions to fetch. Required when the Activity metric is requested as it has to be based on a dimension.", "key": "d", "value": "" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The interval on which data will be grouped. Default value is DAY.", "key": "i", "value": "DAY" }, { "description": "bindOnLastSearch", "key": "bindOnLastSearch", "value": "true" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"globalDatas\": {\n \"ut_2ca\": {\n \"magna6_\": \"\",\n \"dolore_e5\": \"\",\n \"veniam77\": \"\"\n },\n \"Excepteur_08\": {\n \"anim_4f9\": \"\",\n \"irure_5\": \"\"\n },\n \"deserunt___\": {\n \"id6d\": \"\"\n },\n \"labore_d\": {\n \"consectetur__\": \"\",\n \"in_49a\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-592343b4-a8af-41c8-848e-23426720d8c2" } ], "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-1c2a360f-b8dd-45d0-aceb-579aaa4fc733" } ], "id": "ec437cf4-8196-4810-ac1e-432f3d5c867f", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-ec437cf4-8196-4810-ac1e-432f3d5c867f" }, { "name": "graphDataPoints", "item": [ { "name": "Get Graph Data Points for the Metrics for a Date Range", "id": "20f5458f-7d52-46a5-a655-4c94f081cd24", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/stats/graphDataPoints?m=&m=&from=&to=&tz=Z&f=&f=&i=DAY&bindOnLastSearch=true&org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "stats", "graphDataPoints" ], "query": [ { "description": "(Required) The metrics to fetch.", "key": "m", "value": "" }, { "description": "(Required) The metrics to fetch.", "key": "m", "value": "" }, { "description": "(Required) The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "from", "value": "" }, { "description": "(Required) The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "to", "value": "" }, { "description": "Timezone used for calculations.", "key": "tz", "value": "Z" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The interval on which data will be grouped. Default value is DAY.", "key": "i", "value": "DAY" }, { "description": "bindOnLastSearch", "key": "bindOnLastSearch", "value": "true" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024.\nThere is one data point per interval per metric. The interval can be specified with the 'i' query parameter." }, "response": [ { "id": "2d9da8ac-375a-48f4-855f-e5450d3d8c17", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v14/stats/graphDataPoints?m=&from=&to=&tz=Z&f=&i=DAY&bindOnLastSearch=true&org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "stats", "graphDataPoints" ], "query": [ { "description": "(Required) The metrics to fetch.", "key": "m", "value": "" }, { "description": "(Required) The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "from", "value": "" }, { "description": "(Required) The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "to", "value": "" }, { "description": "Timezone used for calculations.", "key": "tz", "value": "Z" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The interval on which data will be grouped. Default value is DAY.", "key": "i", "value": "DAY" }, { "description": "bindOnLastSearch", "key": "bindOnLastSearch", "value": "true" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"dataPoints\": [\n {\n \"datas\": {\n \"eiusmod_e2\": \"\"\n },\n \"dateTime\": \"\"\n },\n {\n \"datas\": {\n \"proident_\": \"\",\n \"irure_7\": \"\"\n },\n \"dateTime\": \"\"\n }\n ],\n \"totals\": {\n \"sunt_9f\": \"\",\n \"ad_5cf\": \"\",\n \"incididunt_fc\": \"\",\n \"adipisicing6_b\": \"\",\n \"proident_068\": \"\"\n },\n \"stats\": {\n \"quis_e27\": {},\n \"ad_2a1\": {},\n \"Ut_b\": {},\n \"exercitation_12\": {}\n }\n}", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-2d9da8ac-375a-48f4-855f-e5450d3d8c17" } ], "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-20f5458f-7d52-46a5-a655-4c94f081cd24" } ], "id": "50d7cb8e-668e-469d-944a-b7db1b005845", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-50d7cb8e-668e-469d-944a-b7db1b005845" }, { "name": "monitoring", "item": [ { "name": "health", "item": [ { "name": "Health Check for the Statistics Service", "id": "72792f1f-2c0c-4f01-a61b-c779524fa67e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/stats/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v14", "stats", "monitoring", "health" ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "a2d948fa-1976-4c39-9579-8b6a3206f480", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v14/stats/monitoring/health", "host": [ "{{baseUrl}}" ], "path": [ "v14", "stats", "monitoring", "health" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-a2d948fa-1976-4c39-9579-8b6a3206f480" } ], "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-72792f1f-2c0c-4f01-a61b-c779524fa67e" } ], "id": "a91491f1-d7aa-4269-84be-3e4d8ee1562e", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-a91491f1-d7aa-4269-84be-3e4d8ee1562e" } ], "id": "71f03bb2-69ea-4f8e-88d5-9379b5f899f2", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-71f03bb2-69ea-4f8e-88d5-9379b5f899f2" }, { "name": "status", "item": [ { "name": "Get the Statistics Service Status", "id": "d628e16f-a657-425d-9202-b48af146f4b1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/stats/status", "host": [ "{{baseUrl}}" ], "path": [ "v14", "stats", "status" ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "826ffeef-5632-4c21-a0d5-1bd30b66c20e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v14/stats/status", "host": [ "{{baseUrl}}" ], "path": [ "v14", "stats", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-826ffeef-5632-4c21-a0d5-1bd30b66c20e" } ], "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-d628e16f-a657-425d-9202-b48af146f4b1" } ], "id": "dfa36938-9354-4614-a3bf-7ac379fe28a2", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-dfa36938-9354-4614-a3bf-7ac379fe28a2" }, { "name": "visits", "item": [ { "name": "Get the Details of the Visits Matching the Specified Criteria", "id": "a99b5dd2-77cc-492d-a8a5-73bcc625ddf4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v14/stats/visits?from=&to=&tz=Z&d=&d=&f=&f=&fn=&fn=&s=eventDatetime&p=&n=&asc=false&includeMetadata=true&org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "stats", "visits" ], "query": [ { "description": "(Required) The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "from", "value": "" }, { "description": "(Required) The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "to", "value": "" }, { "description": "Timezone used for calculations.", "key": "tz", "value": "Z" }, { "description": "The dimensions to fetch.", "key": "d", "value": "" }, { "description": "The dimensions to fetch.", "key": "d", "value": "" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.", "key": "fn", "value": "" }, { "description": "The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.", "key": "fn", "value": "" }, { "description": "The field to order the results by. It must be a dimension, metric or custom dimension that was specified in the 'm' or the 'd' parameter.", "key": "s", "value": "eventDatetime" }, { "description": "The response's page to access, starting at 1.", "key": "p", "value": "" }, { "description": "The number of result to include in a page.", "key": "n", "value": "" }, { "description": "Whether to sort by ascending order.", "key": "asc", "value": "false" }, { "description": "Whether to include metadata regarding the results (total count and unique counts, if applicable).", "key": "includeMetadata", "value": "true" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024." }, "response": [ { "id": "047922d3-bbd8-4b8b-bf9d-9300d01ad837", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v14/stats/visits?from=&to=&tz=Z&d=&f=&fn=&s=eventDatetime&p=&n=&asc=false&includeMetadata=true&org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "stats", "visits" ], "query": [ { "description": "(Required) The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "from", "value": "" }, { "description": "(Required) The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'", "key": "to", "value": "" }, { "description": "Timezone used for calculations.", "key": "tz", "value": "Z" }, { "description": "The dimensions to fetch.", "key": "d", "value": "" }, { "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator.", "key": "f", "value": "" }, { "description": "The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator.", "key": "fn", "value": "" }, { "description": "The field to order the results by. It must be a dimension, metric or custom dimension that was specified in the 'm' or the 'd' parameter.", "key": "s", "value": "eventDatetime" }, { "description": "The response's page to access, starting at 1.", "key": "p", "value": "" }, { "description": "The number of result to include in a page.", "key": "n", "value": "" }, { "description": "Whether to sort by ascending order.", "key": "asc", "value": "false" }, { "description": "Whether to include metadata regarding the results (total count and unique counts, if applicable).", "key": "includeMetadata", "value": "true" }, { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"visits\": [\n {\n \"visitId\": \"\",\n \"numberOfEvents\": \"\"\n },\n {\n \"visitId\": \"\",\n \"numberOfEvents\": \"\"\n }\n ],\n \"totalNumberOfVisits\": \"\"\n}", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-047922d3-bbd8-4b8b-bf9d-9300d01ad837" } ], "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-a99b5dd2-77cc-492d-a8a5-73bcc625ddf4" }, { "name": "Force a Visit View Update", "id": "7a254083-b63b-47ad-a0fb-00910d773f7c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/v14/stats/visits?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "stats", "visits" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] }, "description": "This endpoint is deprecated and will be removed on October 1st, 2024.\nGlobal data contain the total, the daily peak and the daily average." }, "response": [ { "id": "115e12ec-226d-4704-8b27-59121194f700", "name": "No content", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v14/stats/visits?org=", "host": [ "{{baseUrl}}" ], "path": [ "v14", "stats", "visits" ], "query": [ { "description": "The name of the organization (Coveo Cloud V2 only)", "key": "org", "value": "" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-115e12ec-226d-4704-8b27-59121194f700" } ], "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-7a254083-b63b-47ad-a0fb-00910d773f7c" } ], "id": "3e8357e9-8690-4e1b-a9c0-543c3871c2aa", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-3e8357e9-8690-4e1b-a9c0-543c3871c2aa" } ], "id": "aeeb27ab-7151-4a5e-8759-557b34f0ca8e", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-aeeb27ab-7151-4a5e-8759-557b34f0ca8e" } ], "id": "87defe4e-f8f0-4cc0-be93-5705b80ffabc", "createdAt": "2026-07-28T01:32:52.000Z", "updatedAt": "2026-07-28T01:32:52.000Z", "uid": "35240-87defe4e-f8f0-4cc0-be93-5705b80ffabc" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://platform.cloud.coveo.com" } ] }