Metrics on the Platform

Most operations perform actions that create, modify, read, or delete platform resources such as apps, APIs, discussions, tickets, and so forth.

However, there is also a set of operations that monitors and reports on app/API transaction activity. These operations are shown in the table below.

To do this... Use this operation...
Retrieve detailed information about a specific transaction in JSON or XML format

App: GET /api/apps/versions/{AppVersionID}/txlogs/{TransactionID}

API: GET /api/apis/versions/{APIVersionID}/txlogs/{TransactionID}

Retrieve a summary of metrics for the app version, API version, or operation, in JSON format that can be used to create a chart

App: GET /api/apps/versions/{AppVersionID}/metrics

API: GET /api/apis/versions/{APIVersionID}/metrics

Export a summary of metrics for the app version, API version, or operation, to a CSV file

App: GET /api/apps/versions/{AppVersionID}/metrics/export

API: GET /api/apis/versions/{APIVersionID}/metrics/export

Retrieve transaction logs in JSON or XML format

App: GET /api/apps/versions/{AppVersionID}/txlogs

API: GET /api/apis/versions/{APIVersionID}/txlogs

Export transaction logs to a CSV file

App: GET /api/apps/versions/{AppVersionID}/txlogs/export

API: GET /api/apis/versions/{APIVersionID}/txlogs/export

Export a summary of metrics for a specific API operation, in a specific environment, in JSON or XML format GET /api/apis/versions/{APIVersionID}/environments/{Environment}/operations/{OperationName}/txlogs
Export a summary of metrics for a specific API operation, in a specific environment, to a CSV file GET /api/apis/versions/{APIVersionID}/environments/{Environment}/operations/{OperationName}/metrics

Some examples of how you can use these operations, depending on your app or API admin access rights, are:

  • Query how many times an app uses a specific API in a specified timeframe
  • Query the number of requests processed by a specific API in a specified timeframe
  • If an app is using multiple APIs, query how many times it used one API or all APIs
  • Query how much time each request took

Back to top

Related Topics