{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Gamification API", "version": "v2" }, "items": [ { "info": { "name": "Gamification", "type": "folder" }, "items": [ { "info": { "name": "Generates pre-signed URL to upload a prize image for gamification contests", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/gamification/contests/uploads/prizeimages" }, "docs": "Generates pre-signed URL to upload a prize image for gamification contests" }, { "info": { "name": "Write External Metric Data", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/employeeperformance/externalmetrics/data" }, "docs": "Write External Metric Data" }, { "info": { "name": "Get an External Metric Definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/employeeperformance/externalmetrics/definitions/:metricId", "params": [ { "name": "metricId", "value": "", "type": "path", "description": "Specifies the External Metric Definition ID" } ] }, "docs": "Get an External Metric Definition" }, { "info": { "name": "Update External Metric Definition", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/employeeperformance/externalmetrics/definitions/:metricId", "params": [ { "name": "metricId", "value": "", "type": "path", "description": "Specifies the metric definition ID" } ] }, "docs": "Update External Metric Definition" }, { "info": { "name": "Delete an External Metric Definition", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/employeeperformance/externalmetrics/definitions/:metricId", "params": [ { "name": "metricId", "value": "", "type": "path", "description": "Specifies the External Metric Definition ID" } ] }, "docs": "Delete an External Metric Definition" }, { "info": { "name": "Get a list of External Metric Definitions of an organization, sorted by name in ascending order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/employeeperformance/externalmetrics/definitions", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Get a list of External Metric Definitions of an organization, sorted by name in ascending order" }, { "info": { "name": "Create External Metric Definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/employeeperformance/externalmetrics/definitions" }, "docs": "Create External Metric Definition" }, { "info": { "name": "Gamification activation status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/status" }, "docs": "Gamification activation status" }, { "info": { "name": "Update gamification activation status", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/gamification/status" }, "docs": "Update gamification activation status" }, { "info": { "name": "Leaderboard of the requesting user's division or performance profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/leaderboard", "params": [ { "name": "startWorkday", "value": "", "type": "query", "description": "Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "endWorkday", "value": "", "type": "query", "description": "End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "metricId", "value": "", "type": "query", "description": "Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given." } ] }, "docs": "Leaderboard of the requesting user's division or performance profile" }, { "info": { "name": "Best Points of the requesting user's current performance profile or division", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/leaderboard/bestpoints" }, "docs": "Best Points of the requesting user's current performance profile or division" }, { "info": { "name": "Leaderboard by filter type", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/leaderboard/all", "params": [ { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request." }, { "name": "filterId", "value": "", "type": "query", "description": "ID for the filter type. For example, division or performance profile Id" }, { "name": "startWorkday", "value": "", "type": "query", "description": "Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "endWorkday", "value": "", "type": "query", "description": "End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "metricId", "value": "", "type": "query", "description": "Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given." } ] }, "docs": "Leaderboard by filter type" }, { "info": { "name": "Best Points by division or performance profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/leaderboard/all/bestpoints", "params": [ { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request." }, { "name": "filterId", "value": "", "type": "query", "description": "ID for the filter type. For example, division or performance profile Id" } ] }, "docs": "Best Points by division or performance profile" }, { "info": { "name": "Metric definition by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/metricdefinitions/:metricDefinitionId", "params": [ { "name": "metricDefinitionId", "value": "", "type": "path", "description": "metric definition id" } ] }, "docs": "Metric definition by id" }, { "info": { "name": "All metric definitions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/metricdefinitions" }, "docs": "Retrieves the metric definitions and their corresponding default objectives used to create a gamified metric" }, { "info": { "name": "Objective template by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/templates/:templateId", "params": [ { "name": "templateId", "value": "", "type": "path", "description": "template id" } ] }, "docs": "Objective template by id" }, { "info": { "name": "All objective templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/templates" }, "docs": "All objective templates" }, { "info": { "name": "Query performance profiles in date range for a user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/gamification/profiles/users/:userId/query", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The ID of a user." } ] }, "docs": "Query performance profiles in date range for a user" }, { "info": { "name": "Query performance profiles in date range for the current user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/gamification/profiles/users/me/query" }, "docs": "Query performance profiles in date range for the current user" }, { "info": { "name": "Performance profile by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/profiles/:profileId", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "performanceProfileId" } ] }, "docs": "Performance profile by id" }, { "info": { "name": "Updates a performance profile", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/gamification/profiles/:profileId", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "performanceProfileId" } ] }, "docs": "Updates a performance profile" }, { "info": { "name": "Activate a performance profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/gamification/profiles/:profileId/activate", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "performanceProfileId" } ] }, "docs": "Activate a performance profile" }, { "info": { "name": "Deactivate a performance profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/gamification/profiles/:profileId/deactivate", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "performanceProfileId" } ] }, "docs": "Deactivate a performance profile" }, { "info": { "name": "Performance profile of the requesting user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/profiles/users/me", "params": [ { "name": "workday", "value": "", "type": "query", "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" } ] }, "docs": "Performance profile of the requesting user" }, { "info": { "name": "Performance profile of a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/profiles/users/:userId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "workday", "value": "", "type": "query", "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" } ] }, "docs": "Performance profile of a user" }, { "info": { "name": "All performance profiles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/profiles" }, "docs": "All performance profiles" }, { "info": { "name": "Create a new custom performance profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/gamification/profiles", "params": [ { "name": "copyMetrics", "value": "", "type": "query", "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." } ] }, "docs": "Create a new custom performance profile" }, { "info": { "name": "Creates a linked metric", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/gamification/profiles/:sourceProfileId/metrics/:sourceMetricId/link", "params": [ { "name": "sourceProfileId", "value": "", "type": "path", "description": "Source Performance Profile Id" }, { "name": "sourceMetricId", "value": "", "type": "path", "description": "Source Metric Id" } ] }, "docs": "Creates a linked metric" }, { "info": { "name": "Performance profile gamified metric by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/profiles/:profileId/metrics/:metricId", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Performance Profile Id" }, { "name": "metricId", "value": "", "type": "path", "description": "Metric Id" }, { "name": "workday", "value": "", "type": "query", "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" } ] }, "docs": "Performance profile gamified metric by id" }, { "info": { "name": "Updates a metric in performance profile", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/gamification/profiles/:profileId/metrics/:metricId", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Performance Profile Id" }, { "name": "metricId", "value": "", "type": "path", "description": "Metric Id" } ] }, "docs": "Updates a metric in performance profile" }, { "info": { "name": "All metrics for a given performance profile with objective details such as order and maxPoints", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/profiles/:profileId/metrics/objectivedetails", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Performance Profile Id" }, { "name": "workday", "value": "", "type": "query", "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" } ] }, "docs": "All metrics for a given performance profile with objective details such as order and maxPoints" }, { "info": { "name": "All gamified metrics for a given performance profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/profiles/:profileId/metrics", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Performance Profile Id" }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand." }, { "name": "workday", "value": "", "type": "query", "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" }, { "name": "metricIds", "value": "", "type": "query", "description": "List of metric ids to filter the response (Optional, comma-separated)." } ] }, "docs": "All gamified metrics for a given performance profile" }, { "info": { "name": "Creates a gamified metric with a given metric definition and metric objective under in a performance profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/gamification/profiles/:profileId/metrics", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Performance Profile Id" } ] }, "docs": "Creates a gamified metric with a given metric definition and metric objective under in a performance profile" }, { "info": { "name": "Get a Contest Prize Image by Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/contests/:contestId/prizeimages/:prizeImageId", "params": [ { "name": "contestId", "value": "", "type": "path", "description": "The ID of the contest" }, { "name": "prizeImageId", "value": "", "type": "path", "description": "The ID of the prize image" } ] }, "docs": "Get a Contest Prize Image by Id" }, { "info": { "name": "Get a List of Contests (Admin)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/contests", "params": [ { "name": "pageNumber", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "dateStart", "value": "", "type": "query", "description": "Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "dateEnd", "value": "", "type": "query", "description": "End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "status", "value": "", "type": "query" }, { "name": "sortBy", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" } ] }, "docs": "Get a List of Contests (Admin)" }, { "info": { "name": "Creates a Contest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/gamification/contests" }, "docs": "Creates a Contest" }, { "info": { "name": "Get a List of Contests (Agent/Supervisor)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/contests/me", "params": [ { "name": "pageNumber", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "dateStart", "value": "", "type": "query", "description": "Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "dateEnd", "value": "", "type": "query", "description": "End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "status", "value": "", "type": "query" }, { "name": "sortBy", "value": "", "type": "query" }, { "name": "sortOrder", "value": "", "type": "query" }, { "name": "view", "value": "", "type": "query" } ] }, "docs": "Get a List of Contests (Agent/Supervisor)" }, { "info": { "name": "Get a Contest by Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/contests/:contestId", "params": [ { "name": "contestId", "value": "", "type": "path", "description": "The ID of the contest" } ] }, "docs": "Get a Contest by Id" }, { "info": { "name": "Update a Contest by Id", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/gamification/contests/:contestId", "params": [ { "name": "contestId", "value": "", "type": "path", "description": "The ID of the contest" } ] }, "docs": "Update a Contest by Id" }, { "info": { "name": "Finalize a Contest by Id", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/gamification/contests/:contestId", "params": [ { "name": "contestId", "value": "", "type": "path", "description": "The ID of the contest" } ] }, "docs": "Finalize a Contest by Id" }, { "info": { "name": "Delete a Contest by Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/gamification/contests/:contestId", "params": [ { "name": "contestId", "value": "", "type": "path", "description": "The ID of the contest" } ] }, "docs": "Delete a Contest by Id" }, { "info": { "name": "Get Contest Scores (Admin)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/contests/:contestId/agents/scores", "params": [ { "name": "contestId", "value": "", "type": "path", "description": "The ID of the contest" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "workday", "value": "", "type": "query", "description": "Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "returnsView", "value": "", "type": "query", "description": "Desired response results" } ] }, "docs": "Get Contest Scores (Admin)" }, { "info": { "name": "Get Contest Scores for the requesting Agent/Supervisor", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/contests/:contestId/agents/scores/me", "params": [ { "name": "contestId", "value": "", "type": "path", "description": "The ID of the contest" }, { "name": "pageNumber", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "workday", "value": "", "type": "query", "description": "Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "returnsView", "value": "", "type": "query", "description": "Desired response results (Supervisor Only)" } ] }, "docs": "Get Contest Scores for the requesting Agent/Supervisor" }, { "info": { "name": "Get a Contest Score Trend for the requesting Agent", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/contests/:contestId/agents/scores/trends/me", "params": [ { "name": "contestId", "value": "", "type": "path", "description": "The ID of the contest" } ] }, "docs": "Get a Contest Score Trend for the requesting Agent" }, { "info": { "name": "Get a Contest Score Trend (Average Trend)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/contests/:contestId/agents/scores/trends", "params": [ { "name": "contestId", "value": "", "type": "path", "description": "The ID of the contest" } ] }, "docs": "Get a Contest Score Trend (Average Trend)" }, { "info": { "name": "Get insights details for the user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/insights/users/:userId/details", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The ID of a user." }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request." }, { "name": "filterId", "value": "", "type": "query", "description": "ID for the filter type." }, { "name": "granularity", "value": "", "type": "query", "description": "Granularity" }, { "name": "comparativePeriodStartWorkday", "value": "", "type": "query", "description": "The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "primaryPeriodStartWorkday", "value": "", "type": "query", "description": "The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } ] }, "docs": "Get insights details for the user" }, { "info": { "name": "Get insights details for the current user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/insights/details", "params": [ { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request." }, { "name": "filterId", "value": "", "type": "query", "description": "ID for the filter type." }, { "name": "granularity", "value": "", "type": "query", "description": "Granularity" }, { "name": "comparativePeriodStartWorkday", "value": "", "type": "query", "description": "The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "primaryPeriodStartWorkday", "value": "", "type": "query", "description": "The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } ] }, "docs": "Get insights details for the current user" }, { "info": { "name": "Query users in a profile during a period of time", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/insights/members", "params": [ { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request." }, { "name": "filterId", "value": "", "type": "query", "description": "ID for the filter type." }, { "name": "granularity", "value": "", "type": "query", "description": "Granularity" }, { "name": "startWorkday", "value": "", "type": "query", "description": "The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "reportsTo", "value": "", "type": "query", "description": "The reportsTo used by ABAC policies." } ] }, "docs": "Query users in a profile during a period of time" }, { "info": { "name": "Query managers in a profile during a period of time", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/insights/managers", "params": [ { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request." }, { "name": "filterId", "value": "", "type": "query", "description": "ID for the filter type." }, { "name": "granularity", "value": "", "type": "query", "description": "Granularity" }, { "name": "startWorkday", "value": "", "type": "query", "description": "The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Query managers in a profile during a period of time" }, { "info": { "name": "Get insights overall trend", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/insights/groups/trends/all", "params": [ { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request." }, { "name": "filterId", "value": "", "type": "query", "description": "ID for the filter type." }, { "name": "granularity", "value": "", "type": "query", "description": "Granularity" }, { "name": "comparativePeriodStartWorkday", "value": "", "type": "query", "description": "The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "comparativePeriodEndWorkday", "value": "", "type": "query", "description": "The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "primaryPeriodStartWorkday", "value": "", "type": "query", "description": "The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "primaryPeriodEndWorkday", "value": "", "type": "query", "description": "The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } ] }, "docs": "Get insights overall trend" }, { "info": { "name": "Get insights overall trend for the current user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/insights/groups/trends", "params": [ { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request." }, { "name": "filterId", "value": "", "type": "query", "description": "ID for the filter type." }, { "name": "granularity", "value": "", "type": "query", "description": "Granularity" }, { "name": "comparativePeriodStartWorkday", "value": "", "type": "query", "description": "The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "comparativePeriodEndWorkday", "value": "", "type": "query", "description": "The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "primaryPeriodStartWorkday", "value": "", "type": "query", "description": "The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "primaryPeriodEndWorkday", "value": "", "type": "query", "description": "The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } ] }, "docs": "Get insights overall trend for the current user" }, { "info": { "name": "Get insights summary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/insights", "params": [ { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request." }, { "name": "filterId", "value": "", "type": "query", "description": "ID for the filter type." }, { "name": "granularity", "value": "", "type": "query", "description": "Granularity" }, { "name": "comparativePeriodStartWorkday", "value": "", "type": "query", "description": "The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "primaryPeriodStartWorkday", "value": "", "type": "query", "description": "The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortKey", "value": "", "type": "query", "description": "Sort key" }, { "name": "sortMetricId", "value": "", "type": "query", "description": "Sort Metric Id" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "userIds", "value": "", "type": "query", "description": "A list of up to 100 comma-separated user Ids" }, { "name": "reportsTo", "value": "", "type": "query", "description": "The reportsTo used by ABAC policies." } ] }, "docs": "Get insights summary" }, { "info": { "name": "Get insights rankings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/insights/rankings", "params": [ { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request." }, { "name": "filterId", "value": "", "type": "query", "description": "ID for the filter type." }, { "name": "granularity", "value": "", "type": "query", "description": "Granularity" }, { "name": "comparativePeriodStartWorkday", "value": "", "type": "query", "description": "The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "primaryPeriodStartWorkday", "value": "", "type": "query", "description": "The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "sortKey", "value": "", "type": "query", "description": "Sort key" }, { "name": "sortMetricId", "value": "", "type": "query", "description": "Sort Metric Id" }, { "name": "sectionSize", "value": "", "type": "query", "description": "The number of top and bottom users to return before ties" }, { "name": "userIds", "value": "", "type": "query", "description": "A list of up to 100 comma-separated user Ids" }, { "name": "reportsTo", "value": "", "type": "query", "description": "The reportsTo used by ABAC policies." } ] }, "docs": "Get insights rankings" }, { "info": { "name": "Get insights user trend for the current user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/insights/trends", "params": [ { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request." }, { "name": "filterId", "value": "", "type": "query", "description": "ID for the filter type." }, { "name": "granularity", "value": "", "type": "query", "description": "Granularity" }, { "name": "comparativePeriodStartWorkday", "value": "", "type": "query", "description": "The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "comparativePeriodEndWorkday", "value": "", "type": "query", "description": "The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "primaryPeriodStartWorkday", "value": "", "type": "query", "description": "The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "primaryPeriodEndWorkday", "value": "", "type": "query", "description": "The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } ] }, "docs": "Get insights user trend for the current user" }, { "info": { "name": "Get insights user trend for the user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/insights/users/:userId/trends", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The ID of a user." }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request." }, { "name": "filterId", "value": "", "type": "query", "description": "ID for the filter type." }, { "name": "granularity", "value": "", "type": "query", "description": "Granularity" }, { "name": "comparativePeriodStartWorkday", "value": "", "type": "query", "description": "The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "comparativePeriodEndWorkday", "value": "", "type": "query", "description": "The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "primaryPeriodStartWorkday", "value": "", "type": "query", "description": "The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "primaryPeriodEndWorkday", "value": "", "type": "query", "description": "The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } ] }, "docs": "Get insights user trend for the user" }, { "info": { "name": "Members of a given performance profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/profiles/:profileId/members", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Profile Id" } ] }, "docs": "Members of a given performance profile" }, { "info": { "name": "Assign members to a given performance profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/gamification/profiles/:profileId/members", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Profile Id" } ] }, "docs": "Assign members to a given performance profile" }, { "info": { "name": "Validate member assignment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/gamification/profiles/:profileId/members/validate", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Profile Id" } ] }, "docs": "Validate member assignment" }, { "info": { "name": "Average performance values trends by metric of a division or a performance profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/profiles/:profileId/metrics/:metricId/users/values/trends", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "performanceProfileId" }, { "name": "metricId", "value": "", "type": "path", "description": "metricId" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request." }, { "name": "filterId", "value": "", "type": "query", "description": "ID for the filter type. Only required when filterType is Division." }, { "name": "startWorkday", "value": "", "type": "query", "description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "endWorkday", "value": "", "type": "query", "description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "referenceWorkday", "value": "", "type": "query", "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" }, { "name": "timeZone", "value": "", "type": "query", "description": "Timezone for the workday. Defaults to UTC" } ] }, "docs": "Average performance values trends by metric of a division or a performance profile" }, { "info": { "name": "Average performance values trends by metric of a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/profiles/:profileId/metrics/:metricId/users/:userId/values/trends", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "performanceProfileId" }, { "name": "metricId", "value": "", "type": "path", "description": "metricId" }, { "name": "userId", "value": "", "type": "path" }, { "name": "startWorkday", "value": "", "type": "query", "description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "endWorkday", "value": "", "type": "query", "description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "referenceWorkday", "value": "", "type": "query", "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" }, { "name": "timeZone", "value": "", "type": "query", "description": "Timezone for the workday. Defaults to UTC" } ] }, "docs": "Average performance values trends by metric of a user" }, { "info": { "name": "Average performance values trends by metric of the requesting user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/profiles/:profileId/metrics/:metricId/values/trends", "params": [ { "name": "profileId", "value": "", "type": "path", "description": "performanceProfileId" }, { "name": "metricId", "value": "", "type": "path", "description": "metricId" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request. If not set, returns the values trends of the requesting user" }, { "name": "startWorkday", "value": "", "type": "query", "description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "endWorkday", "value": "", "type": "query", "description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "referenceWorkday", "value": "", "type": "query", "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" }, { "name": "timeZone", "value": "", "type": "query", "description": "Timezone for the workday. Defaults to UTC" } ] }, "docs": "Average performance values trends by metric of the requesting user" }, { "info": { "name": "Best points of the requesting user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/bestpoints" }, "docs": "Best points of the requesting user" }, { "info": { "name": "Workday performance metrics of the requesting user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards", "params": [ { "name": "workday", "value": "", "type": "query", "description": "Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand." } ] }, "docs": "Workday performance metrics of the requesting user" }, { "info": { "name": "Attendance status metrics of the requesting user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/attendance", "params": [ { "name": "startWorkday", "value": "", "type": "query", "description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "endWorkday", "value": "", "type": "query", "description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } ] }, "docs": "Attendance status metrics of the requesting user" }, { "info": { "name": "All-time points of the requesting user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/points/alltime", "params": [ { "name": "endWorkday", "value": "", "type": "query", "description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } ] }, "docs": "All-time points of the requesting user" }, { "info": { "name": "Average points of the requesting user's division or performance profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/points/average", "params": [ { "name": "workday", "value": "", "type": "query", "description": "The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } ] }, "docs": "Average points of the requesting user's division or performance profile" }, { "info": { "name": "Points trends of the requesting user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/points/trends", "params": [ { "name": "startWorkday", "value": "", "type": "query", "description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "endWorkday", "value": "", "type": "query", "description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "dayOfWeek", "value": "", "type": "query", "description": "Optional filter to specify which day of weeks to be included in the response" } ] }, "docs": "Points trends of the requesting user" }, { "info": { "name": "Values trends of the requesting user or group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/values/trends", "params": [ { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request. If not set, then the request is for the requesting user." }, { "name": "referenceWorkday", "value": "", "type": "query", "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" }, { "name": "startWorkday", "value": "", "type": "query", "description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "endWorkday", "value": "", "type": "query", "description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "timeZone", "value": "", "type": "query", "description": "Timezone for the workday. Defaults to UTC" } ] }, "docs": "Values trends of the requesting user or group" }, { "info": { "name": "Average values of the requesting user's division or performance profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/values/average", "params": [ { "name": "workday", "value": "", "type": "query", "description": "The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "timeZone", "value": "", "type": "query", "description": "Timezone for the workday. Defaults to UTC" } ] }, "docs": "Average values of the requesting user's division or performance profile" }, { "info": { "name": "Workday performance metrics for a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/users/:userId", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "workday", "value": "", "type": "query", "description": "Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand." } ] }, "docs": "Workday performance metrics for a user" }, { "info": { "name": "Best points of a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/users/:userId/bestpoints", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Best points of a user" }, { "info": { "name": "Attendance status metrics for a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/users/:userId/attendance", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "startWorkday", "value": "", "type": "query", "description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "endWorkday", "value": "", "type": "query", "description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } ] }, "docs": "Attendance status metrics for a user" }, { "info": { "name": "Points trend for a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/users/:userId/points/trends", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "startWorkday", "value": "", "type": "query", "description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "endWorkday", "value": "", "type": "query", "description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "dayOfWeek", "value": "", "type": "query", "description": "Optional filter to specify which day of weeks to be included in the response" } ] }, "docs": "Points trend for a user" }, { "info": { "name": "All-time points for a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/users/:userId/points/alltime", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "endWorkday", "value": "", "type": "query", "description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } ] }, "docs": "All-time points for a user" }, { "info": { "name": "Values trends of a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/users/:userId/values/trends", "params": [ { "name": "userId", "value": "", "type": "path" }, { "name": "startWorkday", "value": "", "type": "query", "description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "endWorkday", "value": "", "type": "query", "description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "timeZone", "value": "", "type": "query", "description": "Timezone for the workday. Defaults to UTC" } ] }, "docs": "Values trends of a user" }, { "info": { "name": "Workday average points by target group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/users/points/average", "params": [ { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request." }, { "name": "filterId", "value": "", "type": "query", "description": "ID for the filter type." }, { "name": "workday", "value": "", "type": "query", "description": "The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } ] }, "docs": "Workday average points by target group" }, { "info": { "name": "Workday average values by target group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/users/values/average", "params": [ { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request." }, { "name": "filterId", "value": "", "type": "query", "description": "ID for the filter type. For example, division Id" }, { "name": "workday", "value": "", "type": "query", "description": "The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "timeZone", "value": "", "type": "query", "description": "Timezone for the workday. Defaults to UTC" } ] }, "docs": "Workday average values by target group" }, { "info": { "name": "Values trend by target group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/gamification/scorecards/users/values/trends", "params": [ { "name": "filterType", "value": "", "type": "query", "description": "Filter type for the query request." }, { "name": "filterId", "value": "", "type": "query", "description": "ID for the filter type." }, { "name": "startWorkday", "value": "", "type": "query", "description": "Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "endWorkday", "value": "", "type": "query", "description": "End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "timeZone", "value": "", "type": "query", "description": "Timezone for the workday. Defaults to UTC" } ] }, "docs": "Values trend by target group" } ] } ], "bundled": true }