TAtalon
Applications

Get Application health

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Display the health of the Application and show the last time the Application was used.

You can also find this information in the Campaign Manager. In your Application, click Settings > Integration API Keys. See the docs.

get/v1/applications/{applicationId}/health_report

Request

Path parameters

applicationIdinteger required

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

Response

OK

summary'OK' | 'WARNING' | 'ERROR' | 'CRITICAL' | 'NONE' required

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.
lastUsedstring date-time required

time of last request relevant to the API health test.

Example response

{
  "lastUsed": "2021-09-12T10:12:42Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.