How Can We Help?

This section describes usage of Query APIs to get information on transactions in HEAL.

Request Details for a Service

To get details of all the requests monitored on a service in an account in HEAL, use the ‘requests’ Query API as follows:
API Name – requests
Format – GET /config/accounts/{accountId}/services/{serviceId}/requests

Input Parameters

TypeNameDescriptionSchemaMandatory / Optional
PathaccountIdID or Identifier of an AccountstringMandatory
PathserviceIdID or Identifier of a servicestringMandatory

 

Output Parameters
Output Type: CSV

  • Request ID – Unique ID of a request.
  • Request Name – Name of a request.
  • Tags – Tag of a request. You may tag a request and use the tag as a filter in the workload dashboard.

Details for a Request

To get details of a specific request monitored on a service in an account in HEAL, use the ‘requests’ Query API as follows:
API Name – requests
Format – GET /config/accounts/{accountId}/services/{serviceId}/requests/{requestId}

Input Parameters

TypeNameDescriptionSchemaMandatory / Optional
PathaccountIdID or Identifier of an AccountstringMandatory
PathserviceIdID or Identifier of a ServicestringMandatory
PathrequestIdID or Identifier of a RequeststringMandatory

 

Output Parameters
Output Type: CSV

  • Request ID – Unique ID of a request
  • Request Name – Name of a request
  • Tags – Tag of a request. You may tag a request and use the tag as a filter in workload dashboard.

 

Sample Input

http://<keycloak_host>:<keycloak_port>/appsone-query-api/v1.0/config/accounts/2/services/3/requests/5

Table of Contents