{ "info": { "_postman_id": "8bf17abf-a75a-4a99-a483-5ef4e6876d5f", "name": "Coveo Activity Activities Organization Endpoints Monitoring 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:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "lastUpdatedBy": "35240", "uid": "35240-8bf17abf-a75a-4a99-a483-5ef4e6876d5f" }, "item": [ { "name": "rest", "item": [ { "name": "monitoring", "item": [ { "name": "global", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "usage", "item": [ { "name": "regions", "item": [ { "name": "Get Usage Per Region for an Organization.", "id": "9b268005-7e29-40ab-88bb-aa32c5cfe05c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/monitoring/global/organizations/:organizationId/usage/regions?numberOfDaysToInclude=7", "host": [ "{{baseUrl}}" ], "path": [ "rest", "monitoring", "global", "organizations", ":organizationId", "usage", "regions" ], "query": [ { "key": "numberOfDaysToInclude", "value": "7" } ], "variable": [ { "id": "96037b35-91dc-48bb-9d21-0fb01bbb9379", "key": "organizationId", "value": "", "description": "(Required) " } ] }, "description": "
Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "cd0cf543-afa5-4851-91a7-5e563762cf6e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/monitoring/global/organizations/:organizationId/usage/regions?numberOfDaysToInclude=7", "host": [ "{{baseUrl}}" ], "path": [ "rest", "monitoring", "global", "organizations", ":organizationId", "usage", "regions" ], "query": [ { "key": "numberOfDaysToInclude", "value": "7" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"organizationId\": \"\",\n \"regionUsageDetails\": [\n {\n \"region\": \"ap-southeast-7\",\n \"organizationRegionType\": \"MAIN\",\n \"totalRequestPercentage\": \"\"\n },\n {\n \"region\": \"eu-central-1\",\n \"organizationRegionType\": \"MAIN\",\n \"totalRequestPercentage\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-cd0cf543-afa5-4851-91a7-5e563762cf6e" } ], "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-9b268005-7e29-40ab-88bb-aa32c5cfe05c" } ], "id": "95951c45-f42f-49d8-acb8-5d16602444b0", "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-95951c45-f42f-49d8-acb8-5d16602444b0" } ], "id": "875cf688-4d52-4c65-99a7-1fc29f8b8ae0", "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-875cf688-4d52-4c65-99a7-1fc29f8b8ae0" }, { "name": "search-hubs", "item": [ { "name": "usage", "item": [ { "name": "Get the Search Hubs Usage for an Organization.", "id": "58dd9148-0d0b-4a59-96da-c403f1368635", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/monitoring/global/organizations/:organizationId/search-hubs/usage?hostname=&numberOfDaysToInclude=7&page=0&perPage=25", "host": [ "{{baseUrl}}" ], "path": [ "rest", "monitoring", "global", "organizations", ":organizationId", "search-hubs", "usage" ], "query": [ { "description": "(Required) ", "key": "hostname", "value": "" }, { "key": "numberOfDaysToInclude", "value": "7" }, { "key": "page", "value": "0" }, { "key": "perPage", "value": "25" } ], "variable": [ { "id": "3ba7b80d-29d6-4928-9f77-c775e8268a9e", "key": "organizationId", "value": "", "description": "(Required) " } ] }, "description": "
Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "1d05822e-b106-4198-9d74-d87594b6d4fa", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/monitoring/global/organizations/:organizationId/search-hubs/usage?hostname=&numberOfDaysToInclude=7&page=0&perPage=25", "host": [ "{{baseUrl}}" ], "path": [ "rest", "monitoring", "global", "organizations", ":organizationId", "search-hubs", "usage" ], "query": [ { "description": "(Required) ", "key": "hostname", "value": "" }, { "key": "numberOfDaysToInclude", "value": "7" }, { "key": "page", "value": "0" }, { "key": "perPage", "value": "25" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"searchHub\": \"\",\n \"lastUsageDate\": \"\"\n },\n {\n \"searchHub\": \"\",\n \"lastUsageDate\": \"\"\n }\n ],\n \"totalEntries\": \"\",\n \"totalPages\": \"\"\n}", "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-1d05822e-b106-4198-9d74-d87594b6d4fa" } ], "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-58dd9148-0d0b-4a59-96da-c403f1368635" } ], "id": "c050690d-87d6-4e76-ba62-797bd7814f8c", "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-c050690d-87d6-4e76-ba62-797bd7814f8c" } ], "id": "7264de90-c1b6-4eb3-af8e-16cd1313960e", "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-7264de90-c1b6-4eb3-af8e-16cd1313960e" }, { "name": "endpoints", "item": [ { "name": "usage", "item": [ { "name": "Get the Endpoints Usage for an Organization.", "id": "be65ad30-c74f-4795-aaeb-e51652b0a5c3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/monitoring/global/organizations/:organizationId/endpoints/usage?numberOfDaysToInclude=7", "host": [ "{{baseUrl}}" ], "path": [ "rest", "monitoring", "global", "organizations", ":organizationId", "endpoints", "usage" ], "query": [ { "key": "numberOfDaysToInclude", "value": "7" } ], "variable": [ { "id": "88ebae24-b131-4e81-ae1a-40880cdad5f5", "key": "organizationId", "value": "", "description": "(Required) " } ] }, "description": "
Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "14118a5a-91e7-45c7-89a2-e3fc96090d9c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/monitoring/global/organizations/:organizationId/endpoints/usage?numberOfDaysToInclude=7", "host": [ "{{baseUrl}}" ], "path": [ "rest", "monitoring", "global", "organizations", ":organizationId", "endpoints", "usage" ], "query": [ { "key": "numberOfDaysToInclude", "value": "7" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"organizationId\": \"\",\n \"customerEndpointUsageStatus\": {\n \"readyForSearch\": \"\"\n },\n \"searchDetails\": {\n \"recommendedEndpointDetails\": {\n \"hostname\": \"\",\n \"requestDetails\": {\n \"totalRequestPercentage\": \"\",\n \"blockedRequestPercentage\": \"\"\n }\n },\n \"wrongEndpointsDetails\": [\n {\n \"hostname\": \"\",\n \"requestDetails\": {\n \"totalRequestPercentage\": \"\",\n \"blockedRequestPercentage\": \"\"\n },\n \"reason\": \"USING_ADMIN_CUSTOM_ENDPOINT_FOR_SEARCH\",\n \"blockedAfter\": \"\"\n },\n {\n \"hostname\": \"\",\n \"requestDetails\": {\n \"totalRequestPercentage\": \"\",\n \"blockedRequestPercentage\": \"\"\n },\n \"reason\": \"USING_SEARCH_ENDPOINT_FOR_UNAUTHORIZED_SERVICE\",\n \"blockedAfter\": \"\"\n }\n ],\n \"otherEndpointsDetails\": [\n {\n \"hostname\": \"\",\n \"requestDetails\": {\n \"totalRequestPercentage\": \"\",\n \"blockedRequestPercentage\": \"\"\n }\n },\n {\n \"hostname\": \"\",\n \"requestDetails\": {\n \"totalRequestPercentage\": \"\",\n \"blockedRequestPercentage\": \"\"\n }\n }\n ]\n },\n \"analyticsDetails\": {\n \"recommendedEndpointDetails\": {\n \"hostname\": \"\",\n \"requestDetails\": {\n \"totalRequestPercentage\": \"\",\n \"blockedRequestPercentage\": \"\"\n }\n },\n \"wrongEndpointsDetails\": [\n {\n \"hostname\": \"\",\n \"requestDetails\": {\n \"totalRequestPercentage\": \"\",\n \"blockedRequestPercentage\": \"\"\n },\n \"reason\": \"USING_SEARCH_ENDPOINT_FOR_ANALYTICS\",\n \"blockedAfter\": \"\"\n },\n {\n \"hostname\": \"\",\n \"requestDetails\": {\n \"totalRequestPercentage\": \"\",\n \"blockedRequestPercentage\": \"\"\n },\n \"reason\": \"USING_SEARCH_ENDPOINT_FOR_ANALYTICS\",\n \"blockedAfter\": \"\"\n }\n ],\n \"otherEndpointsDetails\": [\n {\n \"hostname\": \"\",\n \"requestDetails\": {\n \"totalRequestPercentage\": \"\",\n \"blockedRequestPercentage\": \"\"\n }\n },\n {\n \"hostname\": \"\",\n \"requestDetails\": {\n \"totalRequestPercentage\": \"\",\n \"blockedRequestPercentage\": \"\"\n }\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-14118a5a-91e7-45c7-89a2-e3fc96090d9c" } ], "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-be65ad30-c74f-4795-aaeb-e51652b0a5c3" } ], "id": "5f501c7f-425a-4d21-bd22-253e3eab424b", "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-5f501c7f-425a-4d21-bd22-253e3eab424b" }, { "name": "readiness", "item": [ { "name": "Get the Customer Endpoint Usage Status for an Organization.", "id": "7c3ad88e-5bcd-4e29-bb59-49ca8d70f10b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/monitoring/global/organizations/:organizationId/endpoints/readiness?numberOfDaysToInclude=7", "host": [ "{{baseUrl}}" ], "path": [ "rest", "monitoring", "global", "organizations", ":organizationId", "endpoints", "readiness" ], "query": [ { "key": "numberOfDaysToInclude", "value": "7" } ], "variable": [ { "id": "905e0bbf-2947-42bb-a41a-932356d4e3a7", "key": "organizationId", "value": "", "description": "(Required) " } ] }, "description": "
Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "f2026268-76c9-4fcd-a43a-f0c3aadc5043", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/monitoring/global/organizations/:organizationId/endpoints/readiness?numberOfDaysToInclude=7", "host": [ "{{baseUrl}}" ], "path": [ "rest", "monitoring", "global", "organizations", ":organizationId", "endpoints", "readiness" ], "query": [ { "key": "numberOfDaysToInclude", "value": "7" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"readyForSearch\": \"\"\n}", "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-f2026268-76c9-4fcd-a43a-f0c3aadc5043" } ], "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-7c3ad88e-5bcd-4e29-bb59-49ca8d70f10b" } ], "id": "6e85c8d5-9241-4bab-babb-73b141e851a2", "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-6e85c8d5-9241-4bab-babb-73b141e851a2" } ], "id": "e0dab1ae-3f4b-4b64-84d5-a6b3e7958492", "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-e0dab1ae-3f4b-4b64-84d5-a6b3e7958492" } ], "id": "790af28c-3cda-4a70-833e-88d4b00e0f97", "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-790af28c-3cda-4a70-833e-88d4b00e0f97" } ], "id": "cd23e375-f795-42fe-8e37-27357d906182", "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-cd23e375-f795-42fe-8e37-27357d906182" } ], "id": "7e5c0264-ae34-43f8-82bf-217bb34df6cf", "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-7e5c0264-ae34-43f8-82bf-217bb34df6cf" } ], "id": "8d38ddae-fdee-445c-90bf-74b947dd5f54", "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-8d38ddae-fdee-445c-90bf-74b947dd5f54" } ], "id": "1b81d693-fe61-4ae6-a449-59de4d7df3eb", "createdAt": "2026-07-28T01:29:36.000Z", "updatedAt": "2026-07-28T01:29:36.000Z", "uid": "35240-1b81d693-fe61-4ae6-a449-59de4d7df3eb" } ], "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" } ] }