{ "opencollection": "1.0.0", "info": { "name": "Coveo Activity Activities Statistics 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": "Statistics API - Version 15", "type": "folder" }, "items": [ { "info": { "name": "Cancel the Execution of a Query", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.cloud.coveo.com/v15/stats/query/:queryId", "params": [ { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" } ] }, "docs": "This is a best effort; there is no guarantee that the query will be cancelled. If the query is cancelled, the sender of the now cancelled query will receive a 409 Conflict." }, { "info": { "name": "Get Metrics Combined with Dimensions for a Date Range", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v15/stats/combinedData", "params": [ { "name": "m", "value": "", "type": "query", "description": "The metrics to fetch." }, { "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": "d", "value": "", "type": "query", "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": "fm", "value": "", "type": "query", "description": "The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND operator." }, { "name": "s", "value": "", "type": "query", "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." }, { "name": "p", "value": "", "type": "query", "description": "The response's page to access, starting at 1." }, { "name": "n", "value": "", "type": "query", "description": "The number of results to include in a page." }, { "name": "asc", "value": "", "type": "query", "description": "Whether to sort by ascending order." }, { "name": "includeMetadata", "value": "", "type": "query", "description": "Whether to include metadata regarding the results (total count and unique counts, if applicable)." }, { "name": "format", "value": "", "type": "query", "description": "The format of the response. Default is JSON." }, { "name": "bindOnLastSearch", "value": "", "type": "query", "description": "bindOnLastSearch" }, { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" } ] }, "docs": "There is one value of each metric for every possible dimension combination." }, { "info": { "name": "Get Trends of a Metric Combined with Dimensions for a Date Range", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v15/stats/trends", "params": [ { "name": "m", "value": "", "type": "query", "description": "The metrics to fetch." }, { "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": "previousFrom", "value": "", "type": "query", "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." }, { "name": "previousTo", "value": "", "type": "query", "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." }, { "name": "tz", "value": "", "type": "query", "description": "Timezone used for calculations." }, { "name": "d", "value": "", "type": "query", "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": "fm", "value": "", "type": "query", "description": "The filter that will be applied to the metrics. Multiple filter parameters are joined with the AND operator." }, { "name": "s", "value": "", "type": "query", "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." }, { "name": "p", "value": "", "type": "query", "description": "The response's page to access, starting at 1." }, { "name": "n", "value": "", "type": "query", "description": "The number of results to include in a page." }, { "name": "asc", "value": "", "type": "query", "description": "Whether to sort by ascending order." }, { "name": "includeMetadata", "value": "", "type": "query", "description": "Whether to include metadata regarding the results (total count and unique counts, if applicable)." }, { "name": "format", "value": "", "type": "query", "description": "The format of the response. Default is JSON." }, { "name": "bindOnLastSearch", "value": "", "type": "query", "description": "bindOnLastSearch" }, { "name": "t", "value": "", "type": "query", "description": "The trends to caculate." }, { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" } ] }, "docs": "There is one value of each metric for every possible dimension combination." }, { "info": { "name": "Get Global Data for Each Metric for a Date Range", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v15/stats/globalData", "params": [ { "name": "m", "value": "", "type": "query", "description": "The metrics to fetch." }, { "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": "d", "value": "", "type": "query", "description": "The dimensions to fetch. Required when the Activity metric is requested as it has to be based on a dimension." }, { "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": "i", "value": "", "type": "query", "description": "The interval on which data will be grouped. Default value is DAY." }, { "name": "bindOnLastSearch", "value": "", "type": "query", "description": "bindOnLastSearch" }, { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" } ] }, "docs": "Global data contain the total, the daily peak and the daily average." }, { "info": { "name": "Get Graph Data Points for the Metrics for a Date Range", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v15/stats/graphDataPoints", "params": [ { "name": "m", "value": "", "type": "query", "description": "The metrics to fetch." }, { "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": "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": "i", "value": "", "type": "query", "description": "The interval on which data will be grouped. Default value is DAY." }, { "name": "bindOnLastSearch", "value": "", "type": "query", "description": "bindOnLastSearch" }, { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" } ] }, "docs": "There is one data point per interval per metric. The interval can be specified with the 'i' query parameter." }, { "info": { "name": "Health Check for the Statistics Service", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v15/stats/monitoring/health" }, "docs": "Health Check for the Statistics Service" }, { "info": { "name": "Get the Statistics Service Status", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v15/stats/status" }, "docs": "Get the Statistics Service Status" }, { "info": { "name": "Get Graph Data Points for Visit Based Metrics for a Date Range", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v15/stats/visitsGraphDataPoints", "params": [ { "name": "m", "value": "", "type": "query", "description": "The metrics to fetch." }, { "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": "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": "hideEventFilters", "value": "", "type": "query", "description": "Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator." }, { "name": "fn", "value": "", "type": "query", "description": "The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator." }, { "name": "i", "value": "", "type": "query", "description": "The interval on which data will be grouped. Default value is DAY." }, { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" } ] }, "docs": "There is one data point per interval per metric. The interval can be specified with the 'i' query parameter." }, { "info": { "name": "Get the Metrics Based on the Visits Matching the Specified Criteria", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v15/stats/visitsMetrics", "params": [ { "name": "m", "value": "", "type": "query", "description": "The metrics to fetch." }, { "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": "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": "hideEventFilters", "value": "", "type": "query", "description": "Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator." }, { "name": "fn", "value": "", "type": "query", "description": "The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator." }, { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" } ] }, "docs": "Get the Metrics Based on the Visits Matching the Specified Criteria" }, { "info": { "name": "Get the Details of the Visits Matching the Specified Criteria", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v15/stats/visits", "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": "d", "value": "", "type": "query", "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": "hideEventFilters", "value": "", "type": "query", "description": "Each specified filter is inverted in order to hide events. Multiple filter parameters are joined with the AND operator." }, { "name": "fn", "value": "", "type": "query", "description": "The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator." }, { "name": "s", "value": "", "type": "query", "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." }, { "name": "p", "value": "", "type": "query", "description": "The response's page to access, starting at 1." }, { "name": "n", "value": "", "type": "query", "description": "The number of results to include in a page." }, { "name": "asc", "value": "", "type": "query", "description": "Whether to sort by ascending order." }, { "name": "includeMetadata", "value": "", "type": "query", "description": "Whether to include metadata regarding the results (total count and unique counts, if applicable)." }, { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" } ] }, "docs": "Get the Details of the Visits Matching the Specified Criteria" }, { "info": { "name": "Force a Visit View Update", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/v15/stats/visits", "params": [ { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" } ] }, "docs": "Global data contain the total, the daily peak and the daily average." } ] } ], "bundled": true }