Get Application Api Health

Get Application health

GET/v1/applications/{applicationId}/health_report

Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the Get Application Api Health action (under management).
Fill in the fields below, then reference the result from later steps as {{getApplicationApiHealth.response.data}}.

Request

Path parameters

applicationIdinteger (int64)required

The ID of the Application. It is displayed in your Talon.One deployment URL.

Response

Returns 200 with an object. Read it in later steps with {{getApplicationApiHealth.response.data.<field>}}.

summarystring

One-word summary of the health of the API connection of an application. Possible values are: - `OK`: The Application has received only successful API requests in the last 5 minutes. - `WARNING`: The Application received at least one failed request in the last 5 minutes. - `ERROR`: More than 50% of received requests failed. - `CRITICAL`: All received requests failed. - `NONE`: During the last 5 minutes, the Application hasn't recorded any integration API requests.

One ofOKWARNINGERRORCRITICALNONE

lastUsedstring (date-time)

time of last request relevant to the API health test.

json

{
  "summary": "OK",
  "lastUsed": {}
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Was this page helpful?