/genesys-gamification | Type: Application | PCID required: Yes
Tools
genesys_gamification_delete_contest
Delete a Contest by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contestId | string | Yes | — | The ID of the contest |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contestId": {
"type": "string",
"description": "The ID of the contest"
}
},
"required": [
"PCID",
"contestId"
]
}
genesys_gamification_delete_employeeperformance_externalmetrics_definition
Delete an External Metric Definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
metricId | string | Yes | — | Specifies the External Metric Definition ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"metricId": {
"type": "string",
"description": "Specifies the External Metric Definition ID"
}
},
"required": [
"PCID",
"metricId"
]
}
genesys_gamification_get_contest
Get a Contest by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contestId | string | Yes | — | The ID of the contest |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contestId": {
"type": "string",
"description": "The ID of the contest"
}
},
"required": [
"PCID",
"contestId"
]
}
genesys_gamification_get_contest_agents_scores
Get Contest Scores (Admin) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contestId | string | Yes | — | The ID of the contest |
pageNumber | integer | No | — | Page number for pagination |
pageSize | integer | No | — | Number of results per page |
workday | string | No | — | Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
returnsView | string | No | — | Desired response results |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contestId": {
"type": "string",
"description": "The ID of the contest"
},
"pageNumber": {
"type": "integer",
"description": "Page number for pagination"
},
"pageSize": {
"type": "integer",
"description": "Number of results per page"
},
"workday": {
"type": "string",
"description": "Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"returnsView": {
"type": "string",
"description": "Desired response results",
"enum": [
"All",
"TopAndBottom"
]
}
},
"required": [
"PCID",
"contestId"
]
}
genesys_gamification_get_contest_agents_scores_me
Get Contest Scores for the requesting Agent/Supervisor Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contestId | string | Yes | — | The ID of the contest |
pageNumber | integer | No | — | Page number for pagination |
pageSize | integer | No | — | Number of results per page |
workday | string | No | — | Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
returnsView | string | No | — | Desired response results (Supervisor Only) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contestId": {
"type": "string",
"description": "The ID of the contest"
},
"pageNumber": {
"type": "integer",
"description": "Page number for pagination"
},
"pageSize": {
"type": "integer",
"description": "Number of results per page"
},
"workday": {
"type": "string",
"description": "Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"returnsView": {
"type": "string",
"description": "Desired response results (Supervisor Only)",
"enum": [
"All",
"TopAndBottom"
]
}
},
"required": [
"PCID",
"contestId"
]
}
genesys_gamification_get_contest_agents_scores_trends
Get a Contest Score Trend (Average Trend) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contestId | string | Yes | — | The ID of the contest |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contestId": {
"type": "string",
"description": "The ID of the contest"
}
},
"required": [
"PCID",
"contestId"
]
}
genesys_gamification_get_contest_agents_scores_trends_me
Get a Contest Score Trend for the requesting Agent Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contestId | string | Yes | — | The ID of the contest |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contestId": {
"type": "string",
"description": "The ID of the contest"
}
},
"required": [
"PCID",
"contestId"
]
}
genesys_gamification_get_contest_prizeimage
Get a Contest Prize Image by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contestId | string | Yes | — | The ID of the contest |
prizeImageId | string | Yes | — | The ID of the prize image |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contestId": {
"type": "string",
"description": "The ID of the contest"
},
"prizeImageId": {
"type": "string",
"description": "The ID of the prize image"
}
},
"required": [
"PCID",
"contestId",
"prizeImageId"
]
}
genesys_gamification_get_contests
Get a List of Contests (Admin) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageNumber | integer | No | — | Page number for pagination |
pageSize | integer | No | — | Number of results per page |
dateStart | string | No | — | Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
dateEnd | string | No | — | End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
status | string[] | No | — | The status value |
sortBy | string | No | — | Sort By |
sortOrder | string | No | — | Sort Order |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "Page number for pagination"
},
"pageSize": {
"type": "integer",
"description": "Number of results per page"
},
"dateStart": {
"type": "string",
"description": "Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"dateEnd": {
"type": "string",
"description": "End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"status": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Upcoming",
"Ongoing",
"Pending",
"RecentlyCompleted",
"Completed",
"Cancelled"
]
},
"description": "The status value"
},
"sortBy": {
"type": "string",
"description": "Sort By",
"enum": [
"title",
"dateStart",
"dateEnd",
"dateFinalized",
"status",
"profile",
"participantCount"
]
},
"sortOrder": {
"type": "string",
"description": "Sort Order",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"PCID"
]
}
genesys_gamification_get_contests_me
Get a List of Contests (Agent/Supervisor) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageNumber | integer | No | — | Page number for pagination |
pageSize | integer | No | — | Number of results per page |
dateStart | string | No | — | Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
dateEnd | string | No | — | End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
status | string[] | No | — | The status value |
sortBy | string | No | — | Sort By |
sortOrder | string | No | — | Sort Order |
view | string | No | — | The view value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageNumber": {
"type": "integer",
"description": "Page number for pagination"
},
"pageSize": {
"type": "integer",
"description": "Number of results per page"
},
"dateStart": {
"type": "string",
"description": "Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"dateEnd": {
"type": "string",
"description": "End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"status": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Upcoming",
"Ongoing",
"Pending",
"RecentlyCompleted",
"Completed",
"Cancelled"
]
},
"description": "The status value"
},
"sortBy": {
"type": "string",
"description": "Sort By",
"enum": [
"title",
"dateStart",
"dateEnd",
"dateFinalized",
"status",
"profile",
"participantCount"
]
},
"sortOrder": {
"type": "string",
"description": "Sort Order",
"enum": [
"asc",
"desc"
]
},
"view": {
"type": "string",
"description": "The view value",
"enum": [
"participant",
"creator"
]
}
},
"required": [
"PCID"
]
}
genesys_gamification_get_employeeperformance_externalmetrics_definition
Get an External Metric Definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
metricId | string | Yes | — | Specifies the External Metric Definition ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"metricId": {
"type": "string",
"description": "Specifies the External Metric Definition ID"
}
},
"required": [
"PCID",
"metricId"
]
}
genesys_gamification_get_employeeperformance_externalmetrics_definitions
Get a list of External Metric Definitions of an organization, sorted by name in ascending order Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
}
},
"required": [
"PCID"
]
}
genesys_gamification_get_insights
Get insights summary Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filterType | string | Yes | — | Filter type for the query request. |
filterId | string | Yes | — | ID for the filter type. |
granularity | string | Yes | — | The granularity value |
comparativePeriodStartWorkday | string | Yes | — | The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
primaryPeriodStartWorkday | string | Yes | — | The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
sortKey | string | No | — | Sort key |
sortMetricId | string | No | — | Sort Metric Id |
sortOrder | string | No | — | Sort order |
userIds | string | No | — | A list of up to 100 comma-separated user Ids |
reportsTo | string | No | — | The reportsTo used by ABAC policies. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filterType": {
"type": "string",
"description": "Filter type for the query request.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"filterId": {
"type": "string",
"description": "ID for the filter type."
},
"granularity": {
"type": "string",
"description": "The granularity value",
"enum": [
"Weekly",
"Monthly"
]
},
"comparativePeriodStartWorkday": {
"type": "string",
"description": "The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"primaryPeriodStartWorkday": {
"type": "string",
"description": "The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
},
"sortKey": {
"type": "string",
"description": "Sort key",
"enum": [
"percentOfGoal",
"percentOfGoalChange",
"overallPercentOfGoal",
"overallPercentOfGoalChange",
"value",
"valueChange"
]
},
"sortMetricId": {
"type": "string",
"description": "Sort Metric Id"
},
"sortOrder": {
"type": "string",
"description": "Sort order",
"enum": [
"asc",
"desc"
]
},
"userIds": {
"type": "string",
"description": "A list of up to 100 comma-separated user Ids"
},
"reportsTo": {
"type": "string",
"description": "The reportsTo used by ABAC policies."
}
},
"required": [
"PCID",
"filterType",
"filterId",
"granularity",
"comparativePeriodStartWorkday",
"primaryPeriodStartWorkday"
]
}
genesys_gamification_get_insights_details
Get insights details for the current user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filterType | string | Yes | — | Filter type for the query request. |
filterId | string | Yes | — | ID for the filter type. |
granularity | string | Yes | — | The granularity value |
comparativePeriodStartWorkday | string | Yes | — | The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
primaryPeriodStartWorkday | string | Yes | — | The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filterType": {
"type": "string",
"description": "Filter type for the query request.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"filterId": {
"type": "string",
"description": "ID for the filter type."
},
"granularity": {
"type": "string",
"description": "The granularity value",
"enum": [
"Weekly",
"Monthly"
]
},
"comparativePeriodStartWorkday": {
"type": "string",
"description": "The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"primaryPeriodStartWorkday": {
"type": "string",
"description": "The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
},
"required": [
"PCID",
"filterType",
"filterId",
"granularity",
"comparativePeriodStartWorkday",
"primaryPeriodStartWorkday"
]
}
genesys_gamification_get_insights_groups_trends
Get insights overall trend for the current user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filterType | string | Yes | — | Filter type for the query request. |
filterId | string | Yes | — | ID for the filter type. |
granularity | string | Yes | — | The granularity value |
comparativePeriodStartWorkday | string | Yes | — | The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
comparativePeriodEndWorkday | string | Yes | — | The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
primaryPeriodStartWorkday | string | Yes | — | The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
primaryPeriodEndWorkday | string | Yes | — | The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filterType": {
"type": "string",
"description": "Filter type for the query request.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"filterId": {
"type": "string",
"description": "ID for the filter type."
},
"granularity": {
"type": "string",
"description": "The granularity value",
"enum": [
"Daily",
"Weekly",
"Monthly"
]
},
"comparativePeriodStartWorkday": {
"type": "string",
"description": "The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"comparativePeriodEndWorkday": {
"type": "string",
"description": "The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"primaryPeriodStartWorkday": {
"type": "string",
"description": "The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"primaryPeriodEndWorkday": {
"type": "string",
"description": "The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
},
"required": [
"PCID",
"filterType",
"filterId",
"granularity",
"comparativePeriodStartWorkday",
"comparativePeriodEndWorkday",
"primaryPeriodStartWorkday",
"primaryPeriodEndWorkday"
]
}
genesys_gamification_get_insights_groups_trends_all
Get insights overall trend Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filterType | string | Yes | — | Filter type for the query request. |
filterId | string | Yes | — | ID for the filter type. |
granularity | string | Yes | — | The granularity value |
comparativePeriodStartWorkday | string | Yes | — | The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
comparativePeriodEndWorkday | string | Yes | — | The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
primaryPeriodStartWorkday | string | Yes | — | The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
primaryPeriodEndWorkday | string | Yes | — | The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filterType": {
"type": "string",
"description": "Filter type for the query request.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"filterId": {
"type": "string",
"description": "ID for the filter type."
},
"granularity": {
"type": "string",
"description": "The granularity value",
"enum": [
"Daily",
"Weekly",
"Monthly"
]
},
"comparativePeriodStartWorkday": {
"type": "string",
"description": "The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"comparativePeriodEndWorkday": {
"type": "string",
"description": "The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"primaryPeriodStartWorkday": {
"type": "string",
"description": "The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"primaryPeriodEndWorkday": {
"type": "string",
"description": "The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
},
"required": [
"PCID",
"filterType",
"filterId",
"granularity",
"comparativePeriodStartWorkday",
"comparativePeriodEndWorkday",
"primaryPeriodStartWorkday",
"primaryPeriodEndWorkday"
]
}
genesys_gamification_get_insights_managers
Query managers in a profile during a period of time Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filterType | string | Yes | — | Filter type for the query request. |
filterId | string | Yes | — | ID for the filter type. |
granularity | string | Yes | — | The granularity value |
startWorkday | string | Yes | — | The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filterType": {
"type": "string",
"description": "Filter type for the query request.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"filterId": {
"type": "string",
"description": "ID for the filter type."
},
"granularity": {
"type": "string",
"description": "The granularity value",
"enum": [
"Weekly",
"Monthly"
]
},
"startWorkday": {
"type": "string",
"description": "The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
}
},
"required": [
"PCID",
"filterType",
"filterId",
"granularity",
"startWorkday"
]
}
genesys_gamification_get_insights_members
Query users in a profile during a period of time Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filterType | string | Yes | — | Filter type for the query request. |
filterId | string | Yes | — | ID for the filter type. |
granularity | string | Yes | — | The granularity value |
startWorkday | string | Yes | — | The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
reportsTo | string | No | — | The reportsTo used by ABAC policies. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filterType": {
"type": "string",
"description": "Filter type for the query request.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"filterId": {
"type": "string",
"description": "ID for the filter type."
},
"granularity": {
"type": "string",
"description": "The granularity value",
"enum": [
"Weekly",
"Monthly"
]
},
"startWorkday": {
"type": "string",
"description": "The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"reportsTo": {
"type": "string",
"description": "The reportsTo used by ABAC policies."
}
},
"required": [
"PCID",
"filterType",
"filterId",
"granularity",
"startWorkday"
]
}
genesys_gamification_get_insights_rankings
Get insights rankings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filterType | string | Yes | — | Filter type for the query request. |
filterId | string | Yes | — | ID for the filter type. |
granularity | string | Yes | — | The granularity value |
comparativePeriodStartWorkday | string | Yes | — | The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
primaryPeriodStartWorkday | string | Yes | — | The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
sortKey | string | Yes | — | Sort key |
sortMetricId | string | No | — | Sort Metric Id |
sectionSize | integer | No | — | The number of top and bottom users to return before ties |
userIds | string | No | — | A list of up to 100 comma-separated user Ids |
reportsTo | string | No | — | The reportsTo used by ABAC policies. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filterType": {
"type": "string",
"description": "Filter type for the query request.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"filterId": {
"type": "string",
"description": "ID for the filter type."
},
"granularity": {
"type": "string",
"description": "The granularity value",
"enum": [
"Weekly",
"Monthly"
]
},
"comparativePeriodStartWorkday": {
"type": "string",
"description": "The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"primaryPeriodStartWorkday": {
"type": "string",
"description": "The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"sortKey": {
"type": "string",
"description": "Sort key",
"enum": [
"percentOfGoal",
"percentOfGoalChange",
"overallPercentOfGoal",
"overallPercentOfGoalChange",
"value",
"valueChange"
]
},
"sortMetricId": {
"type": "string",
"description": "Sort Metric Id"
},
"sectionSize": {
"type": "integer",
"description": "The number of top and bottom users to return before ties"
},
"userIds": {
"type": "string",
"description": "A list of up to 100 comma-separated user Ids"
},
"reportsTo": {
"type": "string",
"description": "The reportsTo used by ABAC policies."
}
},
"required": [
"PCID",
"filterType",
"filterId",
"granularity",
"comparativePeriodStartWorkday",
"primaryPeriodStartWorkday",
"sortKey"
]
}
genesys_gamification_get_insights_trends
Get insights user trend for the current user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filterType | string | Yes | — | Filter type for the query request. |
filterId | string | Yes | — | ID for the filter type. |
granularity | string | Yes | — | The granularity value |
comparativePeriodStartWorkday | string | Yes | — | The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
comparativePeriodEndWorkday | string | Yes | — | The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
primaryPeriodStartWorkday | string | Yes | — | The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
primaryPeriodEndWorkday | string | Yes | — | The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filterType": {
"type": "string",
"description": "Filter type for the query request.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"filterId": {
"type": "string",
"description": "ID for the filter type."
},
"granularity": {
"type": "string",
"description": "The granularity value",
"enum": [
"Daily",
"Weekly"
]
},
"comparativePeriodStartWorkday": {
"type": "string",
"description": "The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"comparativePeriodEndWorkday": {
"type": "string",
"description": "The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"primaryPeriodStartWorkday": {
"type": "string",
"description": "The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"primaryPeriodEndWorkday": {
"type": "string",
"description": "The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
},
"required": [
"PCID",
"filterType",
"filterId",
"granularity",
"comparativePeriodStartWorkday",
"comparativePeriodEndWorkday",
"primaryPeriodStartWorkday",
"primaryPeriodEndWorkday"
]
}
genesys_gamification_get_insights_user_details
Get insights details for the user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | The ID of a user. |
filterType | string | Yes | — | Filter type for the query request. |
filterId | string | Yes | — | ID for the filter type. |
granularity | string | Yes | — | The granularity value |
comparativePeriodStartWorkday | string | Yes | — | The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
primaryPeriodStartWorkday | string | Yes | — | The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "The ID of a user."
},
"filterType": {
"type": "string",
"description": "Filter type for the query request.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"filterId": {
"type": "string",
"description": "ID for the filter type."
},
"granularity": {
"type": "string",
"description": "The granularity value",
"enum": [
"Weekly",
"Monthly"
]
},
"comparativePeriodStartWorkday": {
"type": "string",
"description": "The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"primaryPeriodStartWorkday": {
"type": "string",
"description": "The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
},
"required": [
"PCID",
"userId",
"filterType",
"filterId",
"granularity",
"comparativePeriodStartWorkday",
"primaryPeriodStartWorkday"
]
}
genesys_gamification_get_insights_user_trends
Get insights user trend for the user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | The ID of a user. |
filterType | string | Yes | — | Filter type for the query request. |
filterId | string | Yes | — | ID for the filter type. |
granularity | string | Yes | — | The granularity value |
comparativePeriodStartWorkday | string | Yes | — | The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
comparativePeriodEndWorkday | string | Yes | — | The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
primaryPeriodStartWorkday | string | Yes | — | The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
primaryPeriodEndWorkday | string | Yes | — | The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "The ID of a user."
},
"filterType": {
"type": "string",
"description": "Filter type for the query request.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"filterId": {
"type": "string",
"description": "ID for the filter type."
},
"granularity": {
"type": "string",
"description": "The granularity value",
"enum": [
"Daily",
"Weekly"
]
},
"comparativePeriodStartWorkday": {
"type": "string",
"description": "The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"comparativePeriodEndWorkday": {
"type": "string",
"description": "The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"primaryPeriodStartWorkday": {
"type": "string",
"description": "The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"primaryPeriodEndWorkday": {
"type": "string",
"description": "The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
},
"required": [
"PCID",
"userId",
"filterType",
"filterId",
"granularity",
"comparativePeriodStartWorkday",
"comparativePeriodEndWorkday",
"primaryPeriodStartWorkday",
"primaryPeriodEndWorkday"
]
}
genesys_gamification_get_leaderboard
Leaderboard of the requesting user’s division or performance profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
startWorkday | string | Yes | — | Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
endWorkday | string | Yes | — | End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
metricId | string | No | — | Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"startWorkday": {
"type": "string",
"description": "Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"endWorkday": {
"type": "string",
"description": "End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"metricId": {
"type": "string",
"description": "Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given."
}
},
"required": [
"PCID",
"startWorkday",
"endWorkday"
]
}
genesys_gamification_get_leaderboard_all
Leaderboard by filter type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filterType | string | Yes | — | Filter type for the query request. |
filterId | string | Yes | — | ID for the filter type. For example, division or performance profile Id |
startWorkday | string | Yes | — | Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
endWorkday | string | Yes | — | End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
metricId | string | No | — | Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filterType": {
"type": "string",
"description": "Filter type for the query request.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"filterId": {
"type": "string",
"description": "ID for the filter type. For example, division or performance profile Id"
},
"startWorkday": {
"type": "string",
"description": "Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"endWorkday": {
"type": "string",
"description": "End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"metricId": {
"type": "string",
"description": "Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given."
}
},
"required": [
"PCID",
"filterType",
"filterId",
"startWorkday",
"endWorkday"
]
}
genesys_gamification_get_leaderboard_all_bestpoints
Best Points by division or performance profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filterType | string | Yes | — | Filter type for the query request. |
filterId | string | Yes | — | ID for the filter type. For example, division or performance profile Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filterType": {
"type": "string",
"description": "Filter type for the query request.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"filterId": {
"type": "string",
"description": "ID for the filter type. For example, division or performance profile Id"
}
},
"required": [
"PCID",
"filterType",
"filterId"
]
}
genesys_gamification_get_leaderboard_bestpoints
Best Points of the requesting user’s current performance profile or divisionShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
genesys_gamification_get_metricdefinition
Metric definition by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
metricDefinitionId | string | Yes | — | metric definition id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"metricDefinitionId": {
"type": "string",
"description": "metric definition id"
}
},
"required": [
"PCID",
"metricDefinitionId"
]
}
genesys_gamification_get_metricdefinitions
All metric definitionsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
genesys_gamification_get_profile
Performance profile by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | performanceProfileId |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"profileId": {
"type": "string",
"description": "performanceProfileId"
}
},
"required": [
"PCID",
"profileId"
]
}
genesys_gamification_get_profile_members
Members of a given performance profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | Profile Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"profileId": {
"type": "string",
"description": "Profile Id"
}
},
"required": [
"PCID",
"profileId"
]
}
genesys_gamification_get_profile_metric
Performance profile gamified metric by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | Performance Profile Id |
metricId | string | Yes | — | Metric Id |
workday | string | No | — | The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"profileId": {
"type": "string",
"description": "Performance Profile Id"
},
"metricId": {
"type": "string",
"description": "Metric Id"
},
"workday": {
"type": "string",
"description": "The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
},
"required": [
"PCID",
"profileId",
"metricId"
]
}
genesys_gamification_get_profile_metrics
All gamified metrics for a given performance profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | Performance Profile Id |
expand | string[] | No | — | Which fields, if any, to expand. |
workday | string | No | — | The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
metricIds | string | No | — | List of metric ids to filter the response (Optional, comma-separated). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"profileId": {
"type": "string",
"description": "Performance Profile Id"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"objective"
]
},
"description": "Which fields, if any, to expand."
},
"workday": {
"type": "string",
"description": "The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"metricIds": {
"type": "string",
"description": "List of metric ids to filter the response (Optional, comma-separated)."
}
},
"required": [
"PCID",
"profileId"
]
}
genesys_gamification_get_profile_metrics_objectivedetails
All metrics for a given performance profile with objective details such as order and maxPoints Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | Performance Profile Id |
workday | string | No | — | The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"profileId": {
"type": "string",
"description": "Performance Profile Id"
},
"workday": {
"type": "string",
"description": "The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
},
"required": [
"PCID",
"profileId"
]
}
genesys_gamification_get_profiles
All performance profilesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
genesys_gamification_get_profiles_user
Performance profile of a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
workday | string | No | — | Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"workday": {
"type": "string",
"description": "Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
},
"required": [
"PCID",
"userId"
]
}
genesys_gamification_get_profiles_users_me
Performance profile of the requesting user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workday | string | No | — | Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workday": {
"type": "string",
"description": "Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
},
"required": [
"PCID"
]
}
genesys_gamification_get_scorecards
Workday performance metrics of the requesting user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workday | string | Yes | — | Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
expand | string[] | No | — | Which fields, if any, to expand. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workday": {
"type": "string",
"description": "Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"objective"
]
},
"description": "Which fields, if any, to expand."
}
},
"required": [
"PCID",
"workday"
]
}
genesys_gamification_get_scorecards_attendance
Attendance status metrics of the requesting user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
startWorkday | string | Yes | — | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
endWorkday | string | Yes | — | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"startWorkday": {
"type": "string",
"description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"endWorkday": {
"type": "string",
"description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
},
"required": [
"PCID",
"startWorkday",
"endWorkday"
]
}
genesys_gamification_get_scorecards_bestpoints
Best points of the requesting userShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
genesys_gamification_get_scorecards_points_alltime
All-time points of the requesting user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
endWorkday | string | Yes | — | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"endWorkday": {
"type": "string",
"description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
},
"required": [
"PCID",
"endWorkday"
]
}
genesys_gamification_get_scorecards_points_average
Average points of the requesting user’s division or performance profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workday | string | Yes | — | The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workday": {
"type": "string",
"description": "The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
},
"required": [
"PCID",
"workday"
]
}
genesys_gamification_get_scorecards_points_trends
Points trends of the requesting user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
startWorkday | string | Yes | — | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
endWorkday | string | Yes | — | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
dayOfWeek | string | No | — | Optional filter to specify which day of weeks to be included in the response |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"startWorkday": {
"type": "string",
"description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"endWorkday": {
"type": "string",
"description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"dayOfWeek": {
"type": "string",
"description": "Optional filter to specify which day of weeks to be included in the response",
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
}
},
"required": [
"PCID",
"startWorkday",
"endWorkday"
]
}
genesys_gamification_get_scorecards_profile_metric_user_values_trends
Average performance values trends by metric of a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | performanceProfileId |
metricId | string | Yes | — | Metric Id |
userId | string | Yes | — | User Id |
startWorkday | string | Yes | — | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
endWorkday | string | Yes | — | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
referenceWorkday | string | No | — | Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
timeZone | string | No | — | Timezone for the workday. Defaults to UTC |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"profileId": {
"type": "string",
"description": "performanceProfileId"
},
"metricId": {
"type": "string",
"description": "Metric Id"
},
"userId": {
"type": "string",
"description": "User Id"
},
"startWorkday": {
"type": "string",
"description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"endWorkday": {
"type": "string",
"description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"referenceWorkday": {
"type": "string",
"description": "Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"timeZone": {
"type": "string",
"description": "Timezone for the workday. Defaults to UTC"
}
},
"required": [
"PCID",
"profileId",
"metricId",
"userId",
"startWorkday",
"endWorkday"
]
}
genesys_gamification_get_scorecards_profile_metric_users_values_trends
Average performance values trends by metric of a division or a performance profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | performanceProfileId |
metricId | string | Yes | — | Metric Id |
filterType | string | Yes | — | Filter type for the query request. |
filterId | string | No | — | ID for the filter type. Only required when filterType is Division. |
startWorkday | string | Yes | — | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
endWorkday | string | Yes | — | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
referenceWorkday | string | No | — | Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
timeZone | string | No | — | Timezone for the workday. Defaults to UTC |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"profileId": {
"type": "string",
"description": "performanceProfileId"
},
"metricId": {
"type": "string",
"description": "Metric Id"
},
"filterType": {
"type": "string",
"description": "Filter type for the query request.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"filterId": {
"type": "string",
"description": "ID for the filter type. Only required when filterType is Division."
},
"startWorkday": {
"type": "string",
"description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"endWorkday": {
"type": "string",
"description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"referenceWorkday": {
"type": "string",
"description": "Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"timeZone": {
"type": "string",
"description": "Timezone for the workday. Defaults to UTC"
}
},
"required": [
"PCID",
"profileId",
"metricId",
"filterType",
"startWorkday",
"endWorkday"
]
}
genesys_gamification_get_scorecards_profile_metric_values_trends
Average performance values trends by metric of the requesting user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | performanceProfileId |
metricId | string | Yes | — | Metric Id |
filterType | string | No | — | Filter type for the query request. If not set, returns the values trends of the requesting user |
startWorkday | string | Yes | — | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
endWorkday | string | Yes | — | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
referenceWorkday | string | No | — | Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
timeZone | string | No | — | Timezone for the workday. Defaults to UTC |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"profileId": {
"type": "string",
"description": "performanceProfileId"
},
"metricId": {
"type": "string",
"description": "Metric Id"
},
"filterType": {
"type": "string",
"description": "Filter type for the query request. If not set, returns the values trends of the requesting user",
"enum": [
"PerformanceProfile",
"Division"
]
},
"startWorkday": {
"type": "string",
"description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"endWorkday": {
"type": "string",
"description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"referenceWorkday": {
"type": "string",
"description": "Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"timeZone": {
"type": "string",
"description": "Timezone for the workday. Defaults to UTC"
}
},
"required": [
"PCID",
"profileId",
"metricId",
"startWorkday",
"endWorkday"
]
}
genesys_gamification_get_scorecards_user
Workday performance metrics for a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
workday | string | Yes | — | Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
expand | string[] | No | — | Which fields, if any, to expand. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"workday": {
"type": "string",
"description": "Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"objective"
]
},
"description": "Which fields, if any, to expand."
}
},
"required": [
"PCID",
"userId",
"workday"
]
}
genesys_gamification_get_scorecards_user_attendance
Attendance status metrics for a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
startWorkday | string | Yes | — | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
endWorkday | string | Yes | — | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"startWorkday": {
"type": "string",
"description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"endWorkday": {
"type": "string",
"description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
},
"required": [
"PCID",
"userId",
"startWorkday",
"endWorkday"
]
}
genesys_gamification_get_scorecards_user_bestpoints
Best points of a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
}
},
"required": [
"PCID",
"userId"
]
}
genesys_gamification_get_scorecards_user_points_alltime
All-time points for a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
endWorkday | string | Yes | — | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"endWorkday": {
"type": "string",
"description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
},
"required": [
"PCID",
"userId",
"endWorkday"
]
}
genesys_gamification_get_scorecards_user_points_trends
Points trend for a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
startWorkday | string | Yes | — | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
endWorkday | string | Yes | — | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
dayOfWeek | string | No | — | Optional filter to specify which day of weeks to be included in the response |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"startWorkday": {
"type": "string",
"description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"endWorkday": {
"type": "string",
"description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"dayOfWeek": {
"type": "string",
"description": "Optional filter to specify which day of weeks to be included in the response",
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
}
},
"required": [
"PCID",
"userId",
"startWorkday",
"endWorkday"
]
}
genesys_gamification_get_scorecards_user_values_trends
Values trends of a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
startWorkday | string | Yes | — | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
endWorkday | string | Yes | — | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
timeZone | string | No | — | Timezone for the workday. Defaults to UTC |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"startWorkday": {
"type": "string",
"description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"endWorkday": {
"type": "string",
"description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"timeZone": {
"type": "string",
"description": "Timezone for the workday. Defaults to UTC"
}
},
"required": [
"PCID",
"userId",
"startWorkday",
"endWorkday"
]
}
genesys_gamification_get_scorecards_users_points_average
Workday average points by target group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filterType | string | Yes | — | Filter type for the query request. |
filterId | string | Yes | — | ID for the filter type. |
workday | string | Yes | — | The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filterType": {
"type": "string",
"description": "Filter type for the query request.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"filterId": {
"type": "string",
"description": "ID for the filter type."
},
"workday": {
"type": "string",
"description": "The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
},
"required": [
"PCID",
"filterType",
"filterId",
"workday"
]
}
genesys_gamification_get_scorecards_users_values_average
Workday average values by target group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filterType | string | Yes | — | Filter type for the query request. |
filterId | string | Yes | — | ID for the filter type. For example, division Id |
workday | string | Yes | — | The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
timeZone | string | No | — | Timezone for the workday. Defaults to UTC |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filterType": {
"type": "string",
"description": "Filter type for the query request.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"filterId": {
"type": "string",
"description": "ID for the filter type. For example, division Id"
},
"workday": {
"type": "string",
"description": "The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"timeZone": {
"type": "string",
"description": "Timezone for the workday. Defaults to UTC"
}
},
"required": [
"PCID",
"filterType",
"filterId",
"workday"
]
}
genesys_gamification_get_scorecards_users_values_trends
Values trend by target group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filterType | string | Yes | — | Filter type for the query request. |
filterId | string | Yes | — | ID for the filter type. |
startWorkday | string | Yes | — | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
endWorkday | string | Yes | — | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
timeZone | string | No | — | Timezone for the workday. Defaults to UTC |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filterType": {
"type": "string",
"description": "Filter type for the query request.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"filterId": {
"type": "string",
"description": "ID for the filter type."
},
"startWorkday": {
"type": "string",
"description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"endWorkday": {
"type": "string",
"description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"timeZone": {
"type": "string",
"description": "Timezone for the workday. Defaults to UTC"
}
},
"required": [
"PCID",
"filterType",
"filterId",
"startWorkday",
"endWorkday"
]
}
genesys_gamification_get_scorecards_values_average
Average values of the requesting user’s division or performance profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
workday | string | Yes | — | The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
timeZone | string | No | — | Timezone for the workday. Defaults to UTC |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"workday": {
"type": "string",
"description": "The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"timeZone": {
"type": "string",
"description": "Timezone for the workday. Defaults to UTC"
}
},
"required": [
"PCID",
"workday"
]
}
genesys_gamification_get_scorecards_values_trends
Values trends of the requesting user or group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filterType | string | No | — | Filter type for the query request. If not set, then the request is for the requesting user. |
referenceWorkday | string | No | — | Reference workday for the trend. Used to determine the profile of the user as of this date. If not set, then the user’s current profile will be used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
startWorkday | string | Yes | — | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
endWorkday | string | Yes | — | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
timeZone | string | No | — | Timezone for the workday. Defaults to UTC |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filterType": {
"type": "string",
"description": "Filter type for the query request. If not set, then the request is for the requesting user.",
"enum": [
"PerformanceProfile",
"Division"
]
},
"referenceWorkday": {
"type": "string",
"description": "Reference workday for the trend. Used to determine the profile of the user as of this date. If not set, then the user's current profile will be used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"startWorkday": {
"type": "string",
"description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"endWorkday": {
"type": "string",
"description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"timeZone": {
"type": "string",
"description": "Timezone for the workday. Defaults to UTC"
}
},
"required": [
"PCID",
"startWorkday",
"endWorkday"
]
}
genesys_gamification_get_status
Gamification activation statusShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
genesys_gamification_get_template
Objective template by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
templateId | string | Yes | — | template id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"templateId": {
"type": "string",
"description": "template id"
}
},
"required": [
"PCID",
"templateId"
]
}
genesys_gamification_get_templates
All objective templatesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
genesys_gamification_patch_contest
Finalize a Contest by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contestId | string | Yes | — | The ID of the contest |
disqualifiedAgents | object[] | No | — | The Contest finalization disqualified agents |
status | string | Yes | — | The Contest finalization status |
winners | object[] | No | — | The Contest finalization winners |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contestId": {
"type": "string",
"description": "The ID of the contest"
},
"disqualifiedAgents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"note": {
"type": "string",
"description": "The disqualification explanation"
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "The URI for this object"
}
}
},
"description": "The Contest finalization disqualified agents"
},
"status": {
"type": "string",
"description": "The Contest finalization status",
"enum": [
"Completed",
"Cancelled"
]
},
"winners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tier": {
"type": "integer",
"format": "int32",
"description": "The Contest Winner tier"
},
"userIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Contest Winner users at the tier"
}
}
},
"description": "The Contest finalization winners"
}
},
"required": [
"PCID",
"contestId",
"status"
]
}
genesys_gamification_patch_employeeperformance_externalmetrics_definition
Update External Metric Definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
metricId | string | Yes | — | Specifies the metric definition ID |
defaultObjectiveType | string | No | — | The default objective type of the External Metric Definition |
enabled | boolean | No | — | True if the External Metric Definition is enabled |
name | string | No | — | The name of the External Metric Definition |
precision | integer | No | — | The decimal precision of the External Metric Definition. Must be at least 0 and at most 5 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"metricId": {
"type": "string",
"description": "Specifies the metric definition ID"
},
"defaultObjectiveType": {
"type": "string",
"description": "The default objective type of the External Metric Definition",
"enum": [
"HigherIsBetter",
"LowerIsBetter",
"TargetArea"
]
},
"enabled": {
"type": "boolean",
"description": "True if the External Metric Definition is enabled"
},
"name": {
"type": "string",
"description": "The name of the External Metric Definition"
},
"precision": {
"type": "integer",
"description": "The decimal precision of the External Metric Definition. Must be at least 0 and at most 5"
}
},
"required": [
"PCID",
"metricId"
]
}
genesys_gamification_post_contests
Creates a Contest Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
announcementTimezone | string | Yes | — | The Contest’s Announcement Timezone. Valid values are strings of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London |
anonymization | string | Yes | — | The Contest anonymization |
dateAnnounced | string | Yes | — | The Contest’s Announcement Datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateEnd | string | Yes | — | End date of the contest. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
dateStart | string | Yes | — | Start date of the contest. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
description | string | Yes | — | The Contest description |
division | object | No | — | The division value |
id | string | No | — | The globally unique identifier for the object. |
metrics | object[] | Yes | — | The Contest’s Metrics |
participantIds | string[] | Yes | — | The Contest’s participants |
prizes | object[] | Yes | — | The Contest Prizes |
profileId | string | Yes | — | The Contest profile |
selfUri | string | No | — | The URI for this object |
title | string | Yes | — | The Contest title |
winningCriteria | string | Yes | — | The Contest winning criteria |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"announcementTimezone": {
"type": "string",
"description": "The Contest's Announcement Timezone. Valid values are strings of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
},
"anonymization": {
"type": "string",
"description": "The Contest anonymization",
"enum": [
"NoAnonymization",
"All",
"AllExceptTop"
]
},
"dateAnnounced": {
"type": "string",
"description": "The Contest's Announcement Datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateEnd": {
"type": "string",
"description": "End date of the contest. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"dateStart": {
"type": "string",
"description": "Start date of the contest. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"description": {
"type": "string",
"description": "The Contest description"
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"weight": {
"type": "integer",
"format": "int32",
"description": "The Contest Metrics weight, allowed values are 1-100"
},
"minimumQualifier": {
"type": "integer",
"format": "int32",
"description": "The Contest Metrics minimum qualifier. Min value is 0, no Max value"
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "The URI for this object"
}
},
"required": [
"id",
"minimumQualifier",
"weight"
]
},
"description": "The Contest's Metrics"
},
"participantIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Contest's participants"
},
"prizes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tier": {
"type": "integer",
"format": "int32",
"description": "The Contest Prize tier"
},
"name": {
"type": "string",
"description": "The Contest Prize name"
},
"description": {
"type": "string",
"description": "The Contest Prize description"
},
"imageId": {
"type": "string",
"description": "The Contest Prize image id"
},
"imageUrl": {
"type": "string",
"description": "The Contest Prize image url"
},
"winnersCount": {
"type": "integer",
"format": "int32",
"description": "The Contest Prize winner Count"
}
},
"required": [
"description",
"imageId",
"name",
"tier",
"winnersCount"
]
},
"description": "The Contest Prizes"
},
"profileId": {
"type": "string",
"description": "The Contest profile"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"title": {
"type": "string",
"description": "The Contest title"
},
"winningCriteria": {
"type": "string",
"description": "The Contest winning criteria",
"enum": [
"HighestOverallScore",
"HighestOverallPercentOfGoal"
]
}
},
"required": [
"PCID",
"announcementTimezone",
"anonymization",
"dateAnnounced",
"dateEnd",
"dateStart",
"description",
"metrics",
"participantIds",
"prizes",
"profileId",
"title",
"winningCriteria"
]
}
genesys_gamification_post_contests_uploads_prizeimages
Generates pre-signed URL to upload a prize image for gamification contests Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contentLength | integer | Yes | — | The size of the file to upload. |
contentMd5 | string | No | — | Content MD5 of the file to upload |
contentType | string | Yes | — | The content type of the file to upload. |
fileName | string | No | — | Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: {^}%`]”>[~<#| |
serverSideEncryption | string | No | — | Server Side Encryption |
signedUrlTimeoutSeconds | integer | No | — | The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contentLength": {
"type": "integer",
"description": "The size of the file to upload."
},
"contentMd5": {
"type": "string",
"description": "Content MD5 of the file to upload"
},
"contentType": {
"type": "string",
"description": "The content type of the file to upload.",
"enum": [
"image/jpeg",
"image/jpg",
"image/png"
]
},
"fileName": {
"type": "string",
"description": "Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|"
},
"serverSideEncryption": {
"type": "string",
"description": "Server Side Encryption",
"enum": [
"AES256"
]
},
"signedUrlTimeoutSeconds": {
"type": "integer",
"description": "The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds"
}
},
"required": [
"PCID",
"contentLength",
"contentType"
]
}
genesys_gamification_post_employeeperformance_externalmetrics_data
Write External Metric Data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
items | object[] | Yes | — | A list of external metric data items. A maximum of 100 items are allowed. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "The user ID. Must provide either userId or userEmail, but not both."
},
"userEmail": {
"type": "string",
"description": "The user main email used in user's GenesysCloud account. Must provide either userId or userEmail, but not both."
},
"metricId": {
"type": "string",
"description": "The ID of the external metric definition"
},
"dateOccurred": {
"type": "string",
"format": "date",
"description": "The date of the metric data. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"value": {
"type": "number",
"description": "The value of the metric data. When value is null, the metric data will be deleted."
},
"count": {
"type": "integer",
"format": "int32",
"description": "The number of data points. The default value is 0 when type is Cumulative and the metric data already exists, otherwise 1. When total count reaches 0, the metric data will be deleted."
},
"type": {
"type": "string",
"enum": [
"Total",
"Cumulative"
],
"description": "The type of the metric data. The default value is Total."
}
},
"required": [
"dateOccurred",
"metricId",
"value"
]
},
"description": "A list of external metric data items. A maximum of 100 items are allowed."
}
},
"required": [
"PCID",
"items"
]
}
genesys_gamification_post_employeeperformance_externalmetrics_definitions
Create External Metric Definition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
defaultObjectiveType | string | Yes | — | The default objective type of the External Metric Definition |
enabled | boolean | Yes | — | True if the External Metric Definition is enabled |
name | string | Yes | — | The name of the External Metric Definition |
precision | integer | Yes | — | The decimal precision of the External Metric Definition. Must be at least 0 and at most 5 |
unit | string | Yes | — | The unit of the External Metric Definition |
unitDefinition | string | No | — | The unit definition of the External Metric Definition |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"defaultObjectiveType": {
"type": "string",
"description": "The default objective type of the External Metric Definition",
"enum": [
"HigherIsBetter",
"LowerIsBetter",
"TargetArea"
]
},
"enabled": {
"type": "boolean",
"description": "True if the External Metric Definition is enabled"
},
"name": {
"type": "string",
"description": "The name of the External Metric Definition"
},
"precision": {
"type": "integer",
"description": "The decimal precision of the External Metric Definition. Must be at least 0 and at most 5"
},
"unit": {
"type": "string",
"description": "The unit of the External Metric Definition",
"enum": [
"Seconds",
"Percent",
"Number",
"Currency"
]
},
"unitDefinition": {
"type": "string",
"description": "The unit definition of the External Metric Definition"
}
},
"required": [
"PCID",
"defaultObjectiveType",
"enabled",
"name",
"precision",
"unit"
]
}
genesys_gamification_post_profile_activate
Activate a performance profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | performanceProfileId |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"profileId": {
"type": "string",
"description": "performanceProfileId"
}
},
"required": [
"PCID",
"profileId"
]
}
genesys_gamification_post_profile_deactivate
Deactivate a performance profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | performanceProfileId |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"profileId": {
"type": "string",
"description": "performanceProfileId"
}
},
"required": [
"PCID",
"profileId"
]
}
genesys_gamification_post_profile_members
Assign members to a given performance profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | Profile Id |
membersToAssign | string[] | Yes | — | List of user ids to assign to a performance profile |
membersToRemove | string[] | Yes | — | List of user ids to remove from a performance profile |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"profileId": {
"type": "string",
"description": "Profile Id"
},
"membersToAssign": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of user ids to assign to a performance profile"
},
"membersToRemove": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of user ids to remove from a performance profile"
}
},
"required": [
"PCID",
"profileId",
"membersToAssign",
"membersToRemove"
]
}
genesys_gamification_post_profile_members_validate
Validate member assignment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | Profile Id |
membersToAssign | string[] | Yes | — | List of user ids to assign to a performance profile |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"profileId": {
"type": "string",
"description": "Profile Id"
},
"membersToAssign": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of user ids to assign to a performance profile"
}
},
"required": [
"PCID",
"profileId",
"membersToAssign"
]
}
genesys_gamification_post_profile_metric_link
Creates a linked metric Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sourceProfileId | string | Yes | — | Source Performance Profile Id |
sourceMetricId | string | Yes | — | Source Metric Id |
targetPerformanceProfileId | string | Yes | — | The target destination performanceProfileId for the linked metric. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sourceProfileId": {
"type": "string",
"description": "Source Performance Profile Id"
},
"sourceMetricId": {
"type": "string",
"description": "Source Metric Id"
},
"targetPerformanceProfileId": {
"type": "string",
"description": "The target destination performanceProfileId for the linked metric."
}
},
"required": [
"PCID",
"sourceProfileId",
"sourceMetricId",
"targetPerformanceProfileId"
]
}
genesys_gamification_post_profile_metrics
Creates a gamified metric with a given metric definition and metric objective under in a performance profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | Performance Profile Id |
externalMetricDefinitionId | string | No | — | The id of associated external metric definition |
metricDefinitionId | string | No | — | The id of associated metric definition |
name | string | Yes | — | The name of this metric |
objective | object | No | — | The objective value |
performanceProfileId | string | No | — | Performance profile id of this metric |
precision | integer | No | — | The precision of the metric, must be between 0 and 5 |
timeDisplayUnit | string | No | — | The time unit in which the metric should be displayed — this parameter is ignored when displaying non-time values |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"profileId": {
"type": "string",
"description": "Performance Profile Id"
},
"externalMetricDefinitionId": {
"type": "string",
"description": "The id of associated external metric definition"
},
"metricDefinitionId": {
"type": "string",
"description": "The id of associated metric definition"
},
"name": {
"type": "string",
"description": "The name of this metric"
},
"objective": {
"type": "object",
"description": "The objective value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"templateId": {
"type": "string",
"description": "The id of this objective's base template"
},
"zones": {
"type": "array",
"items": {
"type": "object"
},
"description": "Objective zone specifies min,max points and values for the associated metric"
},
"enabled": {
"type": "boolean",
"description": "A flag for whether this objective is enabled for the related metric"
},
"topicIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of topic ids for detected topic metrics"
},
"mediaTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"callback",
"chat",
"cobrowse",
"email",
"internalmessage",
"message",
"screenmonitoring",
"screenshare",
"unknown",
"video",
"voice"
]
},
"description": "A list of media types for the metric"
},
"queueIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of queue ids for the metric"
},
"topicIdsFilterType": {
"type": "string",
"description": "A filter type for topic Ids. It's only used for objectives with topicIds. Default filter behavior is \"or\".",
"enum": [
"and",
"or"
]
},
"evaluationFormContextIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ids of associated evaluation form context, for Quality Evaluation Score metrics"
},
"initialDirection": {
"type": "string",
"description": "The initial direction to filter on",
"enum": [
"inbound",
"outbound"
]
},
"dateStart": {
"type": "string",
"description": "start date of the objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
}
},
"performanceProfileId": {
"type": "string",
"description": "Performance profile id of this metric"
},
"precision": {
"type": "integer",
"description": "The precision of the metric, must be between 0 and 5"
},
"timeDisplayUnit": {
"type": "string",
"description": "The time unit in which the metric should be displayed -- this parameter is ignored when displaying non-time values",
"enum": [
"None",
"Seconds",
"Minutes",
"Hours"
]
}
},
"required": [
"PCID",
"profileId",
"name"
]
}
genesys_gamification_post_profiles
Create a new custom performance profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
copyMetrics | boolean | No | — | Flag to copy metrics. If set to false, there will be no metrics associated with the new profile. If set to true or is absent (the default behavior), all metrics from the default profile will be copied over into the new profile. |
active | boolean | Yes | — | The flag for active profiles |
dateCreated | string | No | — | Creation date for this performance profile. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
description | string | Yes | — | A description about this performance profile |
division | object | Yes | — | The division value |
id | string | No | — | The globally unique identifier for the object. |
maxLeaderboardRankSize | integer | Yes | — | The maximum rank size for the leaderboard. This counts the number of ranks can be retrieved in a leaderboard queries |
memberCount | integer | No | — | The number of members in this performance profile |
metricOrders | string[] | No | — | Order of the associated metrics. The list should contain valid ids for metrics |
name | string | Yes | — | A name for this performance profile |
reportingIntervals | object[] | Yes | — | The reporting interval periods for this performance profile |
selfUri | string | No | — | The URI for this object |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"copyMetrics": {
"type": "boolean",
"description": "Flag to copy metrics. If set to false, there will be no metrics associated with the new profile. If set to true or is absent (the default behavior), all metrics from the default profile will be copied over into the new profile."
},
"active": {
"type": "boolean",
"description": "The flag for active profiles"
},
"dateCreated": {
"type": "string",
"description": "Creation date for this performance profile. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"description": {
"type": "string",
"description": "A description about this performance profile"
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"maxLeaderboardRankSize": {
"type": "integer",
"description": "The maximum rank size for the leaderboard. This counts the number of ranks can be retrieved in a leaderboard queries"
},
"memberCount": {
"type": "integer",
"description": "The number of members in this performance profile"
},
"metricOrders": {
"type": "array",
"items": {
"type": "string"
},
"description": "Order of the associated metrics. The list should contain valid ids for metrics"
},
"name": {
"type": "string",
"description": "A name for this performance profile"
},
"reportingIntervals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"intervalType": {
"type": "string",
"enum": [
"Day",
"Week",
"Month"
],
"description": "The granularity of the reporting interval period"
},
"intervalValue": {
"type": "integer",
"format": "int32",
"description": "The value of the reporting interval period for a given interval type"
}
},
"required": [
"intervalType",
"intervalValue"
]
},
"description": "The reporting interval periods for this performance profile"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"active",
"description",
"division",
"maxLeaderboardRankSize",
"name",
"reportingIntervals"
]
}
genesys_gamification_post_profiles_user_query
Query performance profiles in date range for a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | The ID of a user. |
endWorkday | string | Yes | — | End work day in ISO-8601 format used in the date range. |
startWorkday | string | Yes | — | Start work day in ISO-8601 format used in the date range. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "The ID of a user."
},
"endWorkday": {
"type": "string",
"description": "End work day in ISO-8601 format used in the date range."
},
"startWorkday": {
"type": "string",
"description": "Start work day in ISO-8601 format used in the date range."
}
},
"required": [
"PCID",
"userId",
"endWorkday",
"startWorkday"
]
}
genesys_gamification_post_profiles_users_me_query
Query performance profiles in date range for the current user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
endWorkday | string | Yes | — | End work day in ISO-8601 format used in the date range. |
startWorkday | string | Yes | — | Start work day in ISO-8601 format used in the date range. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"endWorkday": {
"type": "string",
"description": "End work day in ISO-8601 format used in the date range."
},
"startWorkday": {
"type": "string",
"description": "Start work day in ISO-8601 format used in the date range."
}
},
"required": [
"PCID",
"endWorkday",
"startWorkday"
]
}
genesys_gamification_put_contest
Update a Contest by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contestId | string | Yes | — | The ID of the contest |
announcementTimezone | string | Yes | — | The Contest’s Announcement Timezone. Valid values are strings of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London |
anonymization | string | Yes | — | The Contest anonymization |
dateAnnounced | string | Yes | — | The Contest’s Announcement Datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
dateEnd | string | Yes | — | End date of the contest. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
dateStart | string | Yes | — | Start date of the contest. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
description | string | Yes | — | The Contest description |
division | object | No | — | The division value |
id | string | No | — | The globally unique identifier for the object. |
metrics | object[] | Yes | — | The Contest’s Metrics |
participantIds | string[] | Yes | — | The Contest’s participants |
prizes | object[] | Yes | — | The Contest Prizes |
profileId | string | Yes | — | The Contest profile |
selfUri | string | No | — | The URI for this object |
title | string | Yes | — | The Contest title |
winningCriteria | string | Yes | — | The Contest winning criteria |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contestId": {
"type": "string",
"description": "The ID of the contest"
},
"announcementTimezone": {
"type": "string",
"description": "The Contest's Announcement Timezone. Valid values are strings of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
},
"anonymization": {
"type": "string",
"description": "The Contest anonymization",
"enum": [
"NoAnonymization",
"All",
"AllExceptTop"
]
},
"dateAnnounced": {
"type": "string",
"description": "The Contest's Announcement Datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateEnd": {
"type": "string",
"description": "End date of the contest. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"dateStart": {
"type": "string",
"description": "Start date of the contest. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"description": {
"type": "string",
"description": "The Contest description"
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"weight": {
"type": "integer",
"format": "int32",
"description": "The Contest Metrics weight, allowed values are 1-100"
},
"minimumQualifier": {
"type": "integer",
"format": "int32",
"description": "The Contest Metrics minimum qualifier. Min value is 0, no Max value"
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "The URI for this object"
}
},
"required": [
"id",
"minimumQualifier",
"weight"
]
},
"description": "The Contest's Metrics"
},
"participantIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Contest's participants"
},
"prizes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tier": {
"type": "integer",
"format": "int32",
"description": "The Contest Prize tier"
},
"name": {
"type": "string",
"description": "The Contest Prize name"
},
"description": {
"type": "string",
"description": "The Contest Prize description"
},
"imageId": {
"type": "string",
"description": "The Contest Prize image id"
},
"imageUrl": {
"type": "string",
"description": "The Contest Prize image url"
},
"winnersCount": {
"type": "integer",
"format": "int32",
"description": "The Contest Prize winner Count"
}
},
"required": [
"description",
"imageId",
"name",
"tier",
"winnersCount"
]
},
"description": "The Contest Prizes"
},
"profileId": {
"type": "string",
"description": "The Contest profile"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"title": {
"type": "string",
"description": "The Contest title"
},
"winningCriteria": {
"type": "string",
"description": "The Contest winning criteria",
"enum": [
"HighestOverallScore",
"HighestOverallPercentOfGoal"
]
}
},
"required": [
"PCID",
"contestId",
"announcementTimezone",
"anonymization",
"dateAnnounced",
"dateEnd",
"dateStart",
"description",
"metrics",
"participantIds",
"prizes",
"profileId",
"title",
"winningCriteria"
]
}
genesys_gamification_put_profile
Updates a performance profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | performanceProfileId |
active | boolean | No | — | The flag for active profiles |
dateCreated | string | No | — | Creation date for this performance profile. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
description | string | Yes | — | A description about this performance profile |
division | object | No | — | The division value |
id | string | No | — | The globally unique identifier for the object. |
maxLeaderboardRankSize | integer | No | — | The maximum rank size for the leaderboard. This counts the number of ranks can be retrieved in a leaderboard queries |
memberCount | integer | No | — | The number of members in this performance profile |
metricOrders | string[] | Yes | — | Order of the associated metrics. The list should contain valid ids for metrics |
name | string | Yes | — | A name for this performance profile |
reportingIntervals | object[] | No | — | The reporting interval periods for this performance profile |
selfUri | string | No | — | The URI for this object |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"profileId": {
"type": "string",
"description": "performanceProfileId"
},
"active": {
"type": "boolean",
"description": "The flag for active profiles"
},
"dateCreated": {
"type": "string",
"description": "Creation date for this performance profile. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"description": {
"type": "string",
"description": "A description about this performance profile"
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"maxLeaderboardRankSize": {
"type": "integer",
"description": "The maximum rank size for the leaderboard. This counts the number of ranks can be retrieved in a leaderboard queries"
},
"memberCount": {
"type": "integer",
"description": "The number of members in this performance profile"
},
"metricOrders": {
"type": "array",
"items": {
"type": "string"
},
"description": "Order of the associated metrics. The list should contain valid ids for metrics"
},
"name": {
"type": "string",
"description": "A name for this performance profile"
},
"reportingIntervals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"intervalType": {
"type": "string",
"enum": [
"Day",
"Week",
"Month"
],
"description": "The granularity of the reporting interval period"
},
"intervalValue": {
"type": "integer",
"format": "int32",
"description": "The value of the reporting interval period for a given interval type"
}
},
"required": [
"intervalType",
"intervalValue"
]
},
"description": "The reporting interval periods for this performance profile"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"profileId",
"description",
"metricOrders",
"name"
]
}
genesys_gamification_put_profile_metric
Updates a metric in performance profile Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | Performance Profile Id |
metricId | string | Yes | — | Metric Id |
externalMetricDefinitionId | string | No | — | The id of associated external metric definition |
metricDefinitionId | string | No | — | The id of associated metric definition |
name | string | Yes | — | The name of this metric |
objective | object | No | — | The objective value |
performanceProfileId | string | No | — | Performance profile id of this metric |
precision | integer | No | — | The precision of the metric, must be between 0 and 5 |
timeDisplayUnit | string | No | — | The time unit in which the metric should be displayed — this parameter is ignored when displaying non-time values |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"profileId": {
"type": "string",
"description": "Performance Profile Id"
},
"metricId": {
"type": "string",
"description": "Metric Id"
},
"externalMetricDefinitionId": {
"type": "string",
"description": "The id of associated external metric definition"
},
"metricDefinitionId": {
"type": "string",
"description": "The id of associated metric definition"
},
"name": {
"type": "string",
"description": "The name of this metric"
},
"objective": {
"type": "object",
"description": "The objective value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"templateId": {
"type": "string",
"description": "The id of this objective's base template"
},
"zones": {
"type": "array",
"items": {
"type": "object"
},
"description": "Objective zone specifies min,max points and values for the associated metric"
},
"enabled": {
"type": "boolean",
"description": "A flag for whether this objective is enabled for the related metric"
},
"topicIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of topic ids for detected topic metrics"
},
"mediaTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"callback",
"chat",
"cobrowse",
"email",
"internalmessage",
"message",
"screenmonitoring",
"screenshare",
"unknown",
"video",
"voice"
]
},
"description": "A list of media types for the metric"
},
"queueIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of queue ids for the metric"
},
"topicIdsFilterType": {
"type": "string",
"description": "A filter type for topic Ids. It's only used for objectives with topicIds. Default filter behavior is \"or\".",
"enum": [
"and",
"or"
]
},
"evaluationFormContextIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ids of associated evaluation form context, for Quality Evaluation Score metrics"
},
"initialDirection": {
"type": "string",
"description": "The initial direction to filter on",
"enum": [
"inbound",
"outbound"
]
},
"dateStart": {
"type": "string",
"description": "start date of the objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
}
}
},
"performanceProfileId": {
"type": "string",
"description": "Performance profile id of this metric"
},
"precision": {
"type": "integer",
"description": "The precision of the metric, must be between 0 and 5"
},
"timeDisplayUnit": {
"type": "string",
"description": "The time unit in which the metric should be displayed -- this parameter is ignored when displaying non-time values",
"enum": [
"None",
"Seconds",
"Minutes",
"Hours"
]
}
},
"required": [
"PCID",
"profileId",
"metricId",
"name"
]
}
genesys_gamification_put_status
Update gamification activation status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
automaticUserAssignment | boolean | No | — | Automatic assignment of users to the default profile |
dateStart | string | No | — | Gamification start date. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
dateStartPersonalBest | string | No | — | Personal best aggregation starting date. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd |
isActive | boolean | No | — | Gamification status of the organization. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"automaticUserAssignment": {
"type": "boolean",
"description": "Automatic assignment of users to the default profile"
},
"dateStart": {
"type": "string",
"description": "Gamification start date. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"dateStartPersonalBest": {
"type": "string",
"description": "Personal best aggregation starting date. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"
},
"isActive": {
"type": "boolean",
"description": "Gamification status of the organization."
}
},
"required": [
"PCID"
]
}