{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Journey - Profile Creation & Insights API API", "version": "1.0.0" }, "items": [ { "info": { "name": "Journey - Profile Creation & Insights API", "type": "folder" }, "items": [ { "info": { "name": "Get A specific Template searched by template id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "638844db13272c52239c525d", "type": "path", "description": "Template ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Template details by template Id in JDS. \n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_write scope." }, { "info": { "name": "Update existing ProfileViewTemplate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "638844db13272c52239c525d", "type": "path", "description": "Template ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update existing Profile View Template in JDS. \n\nRole and Scope: Requires id full admin or any role with cjp:config_write scope." }, { "info": { "name": "Delete Template by template Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "638844db13272c52239c525d", "type": "path", "description": "Template ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete Template By template id in JDS. \n\nRole and Scope: Requires id full admin or any role with cjp:config_write scope." }, { "info": { "name": "Get All Template Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "filter", "value": "createdBy==satjonna@cisco.com", "type": "query", "description": "Optional filter which can be applied to the elements to be fetched. \n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/documentation/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference)." }, { "name": "sort", "value": "DESC", "type": "query", "description": "Sort direction" }, { "name": "sortBy", "value": "updatedAt", "type": "query", "description": "Sort By Field" }, { "name": "page", "value": "0", "type": "query", "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0." }, { "name": "pageSize", "value": "10", "type": "query", "description": "Number of items to be displayed on a page." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Template details by Organization Id and workspaceId in JDS. \n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope." }, { "info": { "name": "Create Template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a Profile View Template in JDS. \n\n **Role and Scope**: Requires id full admin or any role with cjp:config_write scope.\n\n **Template with single rule**: \n ```\n {\n \"name\": \"ClosedCaller\",\n \"attributes\": [\n {\n \"version\": \"0.1\",\n \"event\": \"Closed Queue\",\n \"metaDataType\": \"string\",\n \"metaData\": \"category\",\n \"limit\": 100,\n \"displayName\": \"ClosedCaller\",\n \"lookBackDurationType\": \"minutes\",\n \"lookBackPeriod\": 5,\n \"aggreg" }, { "info": { "name": "Get A specific Template searched by template name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-name/:templateName", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateName", "value": "sample-template", "type": "path", "description": "Template Name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Template details by template Name in JDS. \n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope." }, { "info": { "name": "Historic Progressive Profile View by Template Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" }, { "name": "personId", "value": "56fghn344678defjs878", "type": "path", "description": "Person ID" }, { "name": "templateName", "value": "insurance-template", "type": "path", "description": "Template Name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Historic Progressive Profile View in JDS. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope." }, { "info": { "name": "Historic Progressive Profile View", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" }, { "name": "personId", "value": "56fghn344678defjs878", "type": "path", "description": "Person ID" }, { "name": "templateId", "value": "56fghn344678defjs878", "type": "path", "description": "Template ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Historic Progressive Profile View in JDS. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope." }, { "info": { "name": "Historic Progressive Profile View By Template Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" }, { "name": "identity", "value": "ram@cisco.com", "type": "path", "description": "Identity" }, { "name": "templateName", "value": "insurance-template", "type": "path", "description": "Template Name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Historic Progressive Profile View in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes" }, { "info": { "name": "Historic Progressive Profile View By Template Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" }, { "name": "identity", "value": "ram@cisco.com", "type": "path", "description": "identity" }, { "name": "templateId", "value": "56fghn344678defjs878", "type": "path", "description": "Template ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Historic Progressive Profile View in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes" }, { "info": { "name": "Stream Progressive profile Views By Template Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" }, { "name": "identity", "value": "srindura@gmail.com", "type": "path", "description": "Identity to search Progressive Profile View for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter." }, { "name": "templateName", "value": "insurance-template", "type": "path", "description": "Template Name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Real-time streaming enables API consumers to listen for Progressive profile Views as it created/updated as part of the Journey; these may be transformed, value-added/enriched, and ready to be consumed or forwarded to another destination. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope." }, { "info": { "name": "Stream Progressive profile Views By Template Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" }, { "name": "identity", "value": "srindura@gmail.com", "type": "path", "description": "Identity to search Progressive Profile View for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter." }, { "name": "templateId", "value": "56fghn344678defjs878", "type": "path", "description": "Template ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Real-time streaming enables API consumers to listen for Progressive profile Views as it created/updated as part of the Journey; these may be transformed, value-added/enriched, and ready to be consumed or forwarded to another destination. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope." }, { "info": { "name": "Historic Journey Events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/api/events/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" }, { "name": "identity", "value": "ram@cisco.com", "type": "query", "description": "Identity to search events for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter." }, { "name": "sortBy", "value": "identity", "type": "query", "description": "sort By Field" }, { "name": "sort", "value": "desc", "type": "query", "description": "sort direction" }, { "name": "filter", "value": "identityType=='phone'", "type": "query", "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/documentation/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference)." }, { "name": "data", "value": "agentid=='3224343fddfdfdf'", "type": "query", "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/documentation/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference)." }, { "name": "page", "value": "0", "type": "query", "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0." }, { "name": "pageSize", "value": "10", "type": "query", "description": "Number of items to be displayed on a page." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Getting Historic Customer Journey Events from Pinot. These events are append-only, immutable data ledger that can be queried to retrieve snapshot of latest events that moment in time or historically to play-back events as they occurred to understand or analyze Journeys using ML/AI models. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope." }, { "info": { "name": "Stream Events By Identity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" }, { "name": "identity", "value": "ram@cisco.com", "type": "path", "description": "Person Identity. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter." }, { "name": "filter", "value": "identityType=='phone'", "type": "query", "description": "Optional filter which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/documentation/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference)." }, { "name": "data", "value": "agentid=='3224343fddfdfdf'", "type": "query", "description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see [this reference](https://developer.here.com/documentation/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Real-time streaming enables API consumers to listen for events as it arrives as part of the Journey; these may be transformed, value-added/enriched, and ready to be consumed or forwarded to another destination. Optionally accepts filter and data parameters slice/dice further. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope." } ] } ], "bundled": true }