You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: build/APIData.json
+31-12Lines changed: 31 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -19239,6 +19239,35 @@
19239
19239
"return": "JourneyEventDefinitionListing",
19240
19240
"example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.JourneyApi();\n\n// Get a list of Event Definitions\napiInstance.getJourneyViewsEventdefinitions()\n .then((data) => {\n console.log(`getJourneyViewsEventdefinitions success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getJourneyViewsEventdefinitions\");\n console.error(err);\n });"
"example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.JourneyApi();\n\nlet opts = { \n \"pageNumber\": 1, // Number | The number of the page to return\n \"pageSize\": 25, // Number | Max number of entities to return\n \"interval\": 2023-07-17T00:00:00Z/2023-07-18T00:00:00Z, // String | An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.\n \"statuses\": statuses=Accepted,Executing,Complete,Failed // String | Job statuses to filter for\n};\n\n// Get the jobs for an organization.\napiInstance.getJourneyViewsJobs(opts)\n .then((data) => {\n console.log(`getJourneyViewsJobs success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getJourneyViewsJobs\");\n console.error(err);\n });"
"example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.QualityApi();\n\nlet opts = { \n \"pageSize\": 25, // Number | The total page size requested\n \"pageNumber\": 1, // Number | The page number requested\n \"sortBy\": \"sortBy_example\", // String | NOTE: Does not work when querying evaluations\n \"expand\": [\"expand_example\"], // [String] | variable name requested by expand list\n \"nextPage\": \"nextPage_example\", // String | NOTE: Does not work when querying evaluations\n \"previousPage\": \"previousPage_example\", // String | Previous page token\n \"conversationId\": \"conversationId_example\", // String | conversationId specified\n \"agentUserId\": \"agentUserId_example\", // String | user id of the agent\n \"agentTeamId\": \"agentTeamId_example\", // String | team id of the agent\n \"evaluatorUserId\": \"evaluatorUserId_example\", // String | evaluator user id\n \"assigneeUserId\": \"assigneeUserId_example\", // String | assignee user id\n \"queueId\": \"queueId_example\", // String | queue id\n \"startTime\": \"startTime_example\", // String | start time of the evaluation query\n \"endTime\": \"endTime_example\", // String | end time of the evaluation query\n \"formContextId\": \"formContextId_example\", // String | shared id between form versions\n \"evaluationState\": [\"evaluationState_example\"], // [String] | \n \"isReleased\": true, // Boolean | the evaluation has been released\n \"agentHasRead\": true, // Boolean | agent has the evaluation\n \"expandAnswerTotalScores\": true, // Boolean | get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request.\n \"maximum\": 3.4, // Number | the maximum number of results to return\n \"sortOrder\": \"sortOrder_example\" // String | NOTE: Does not work when conversationId is supplied.\n};\n\n// Queries Evaluations and returns a paged list\napiInstance.getQualityEvaluationsQuery(opts)\n .then((data) => {\n console.log(`getQualityEvaluationsQuery success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getQualityEvaluationsQuery\");\n console.error(err);\n });"
30131
+
"example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.QualityApi();\n\nlet opts = { \n \"pageSize\": 25, // Number | The total page size requested\n \"pageNumber\": 1, // Number | The page number requested\n \"expand\": [\"expand_example\"], // [String] | variable name requested by expand list\n \"previousPage\": \"previousPage_example\", // String | Previous page token\n \"conversationId\": \"conversationId_example\", // String | conversationId specified\n \"agentUserId\": \"agentUserId_example\", // String | user id of the agent\n \"agentTeamId\": \"agentTeamId_example\", // String | team id of the agent\n \"evaluatorUserId\": \"evaluatorUserId_example\", // String | evaluator user id\n \"assigneeUserId\": \"assigneeUserId_example\", // String | assignee user id\n \"queueId\": \"queueId_example\", // String | queue id\n \"startTime\": \"startTime_example\", // String | start time of the evaluation query\n \"endTime\": \"endTime_example\", // String | end time of the evaluation query\n \"formContextId\": \"formContextId_example\", // String | shared id between form versions\n \"evaluationState\": [\"evaluationState_example\"], // [String] | \n \"isReleased\": true, // Boolean | the evaluation has been released\n \"agentHasRead\": true, // Boolean | agent has the evaluation\n \"expandAnswerTotalScores\": true, // Boolean | get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request.\n \"maximum\": 3.4, // Number | the maximum number of results to return\n \"sortOrder\": \"sortOrder_example\" // String | NOTE: Does not work when conversationId is supplied.\n};\n\n// Queries Evaluations and returns a paged list\napiInstance.getQualityEvaluationsQuery(opts)\n .then((data) => {\n console.log(`getQualityEvaluationsQuery success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getQualityEvaluationsQuery\");\n console.error(err);\n });"
0 commit comments