Lithium

Lithium Health API

The Health API from Lithium — 1 operation(s) for health.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.khoros.com/khoroscaredevdocs/docs/khoros-care-integration-overview
📖
Documentation
https://developer.khoros.com/khorosmarketingdevdocs/docs/developing-and-integrating-with-khoros-marketing
📖
Documentation
https://developer.khoros.com/khoros-flow/docs/overview-of-khoros-flow-apis

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lithium/refs/heads/main/openapi/lithium-health-api-openapi.yml

OpenAPI Specification

lithium-health-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: agent-states-api-v2 AccountSet Health API
  version: '1.1'
servers:
- url: https://{instance}.response.lithium.com/api/v2/agentstate
  variables:
    instance:
      default: instance
security:
- {}
tags:
- name: Health
paths:
  /health/appId/{appId}:
    get:
      summary: Get bot health status by app ID
      description: Get the health status of a bot using the Automation Framework
      operationId: healthappidappid
      parameters:
      - name: appId
        in: path
        description: The bot identifier
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{  \n  \"data\":[  \n    {  \n      \"status\":\"DEGRADED\",\n      \"failureCount\":2,\n      \"successCount\":23\n    }\n  ]\n}"
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        status:
                          type: string
                          example: DEGRADED
                        failureCount:
                          type: integer
                          example: 2
                          default: 0
                        successCount:
                          type: integer
                          example: 23
                          default: 0
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      security: []
      x-readme:
        code-samples:
        - language: curl
          code: "curl GET \\\n  \"https://api.app.lithium.com/bots/v3/health/appId/mybot\" \\\n  -H \"Authorization: Bearer [TOKEN]\"\n"
        samples-languages:
        - curl
      tags:
      - Health
x-readme:
  headers: []
  explorer-enabled: false
  proxy-enabled: false
x-readme-fauxas: true