[Deprecated] Catalyst - Metrics Toolkit

Number of APIs: 4

July 2023 - Migration Announcement

Exciting news! The MuleSoft Anypoint Platform APIs you've come to rely on are transitioning to a new home! We're relocating them to the number one ranked Qodex Workspace worldwide - Salesforce Developers Workspace.

This move situates the MuleSoft Anypoint Platform APIs in the most renowned and widely used Qodex Workspace ever. Within the Salesforce Developers Workspace, you'll be able to access all things related to 'MuleSoft Anypoint Platforms APIs', right in the heart of the world's premier Qodex Workspace.

Actions:

  • Visit the [Salesforce Qodex Workspace] Fork and Watch the Collection to keep up to date
  • Fill this 5 Minutes MuleSoft Platform APIs in Qodex Survey, what do you want to see in the future?
  • [Qodex's official Source] on our point of being the #1 Qodex Workspace in the history of Qodex!

Thank you MuleSoft Community!


Metrics Toolkit

This provides endpoints for the Anypoint Metrics Toolkit API.

Github Repo

Find all the details here: https://github.com/mulesoft-catalyst/metrics-toolkit/tree/master/Qodex

Contributors

https://github.com/mulesoft-catalyst/metrics-toolkit/graphs/contributors

Features

It contains the categories of requests listed below, which are separated into folders.

  • Benefits
  • Platform Metrics

This also has prerequest scripts to handle headers. Each folder has a script that automatically sets Anypoint Platform headers for the folder's requests. This is in each folder that has Anypoint Platform requests, as some folders (SDLC) don't need those headers.

Setup

This requires variables to be set for the requests to work.

Environment Variables

  • url: The base url for the API. This contains the HTTP protocol, domain, and port. Example: http://localhost:8081

Global Variables

  • anypointOrg: The root Anypoint organization on which to run the metrics.
  • credentialType: Determines which Anypoint credential headers to generate. user for Anypoint Platform user credentials; app for connected app client credentials.
  • anypointUsername: Used for Anypoint Platform user credentials.
  • anypointPassword: Used for Anypoint Platform user credentials.
  • connectedAppId: Used for Connected App credentials.
  • connectedAppSecret: Used for Connected App credentials.
  • isPlaintextSecret: Indicates if the secret in the credentials is Base64 encoded or not. If true, it is not encoded.
  1. Benefits - Get Benefits GET {{url}}/api/business-metrics?developAPIHistoricTime=20&developAPICurrentTime=10&maintainAPIHistoricTime=15&maintainAPICurrentTime=7&developerDayRate=200

  2. Platform Metrics - Get Platform Metrics GET {{url}}/api/platform-metrics?raw=false

  3. Benefits - Benefits Load - SFDC POST {{url}}/api/business-metrics/load

  4. Platform Metrics - Platform Metrics Load - SFDC POST {{url}}/api/platform-metrics/load