Jump to

• Request
• Response

Ping

get

/api/v1/aia/sg/call-summary/summaries/ping

Ping the API to verify that the API is operating properly.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Response

Body ()

Root Schema : PingResponse

Type: object

Title: PingResponse

Show Source

• api(required): string
  Title: HealthStatus

  Allowed Values: [ "BAD", "OK", "UNKNOWN" ]

  The health of the API.

{
    "properties":{
        "api":{
            "type":"string",
            "enum":[
                "BAD",
                "OK",
                "UNKNOWN"
            ],
            "title":"HealthStatus",
            "description":"The health of the API."
        }
    },
    "type":"object",
    "required":[
        "api"
    ],
    "title":"PingResponse"
}

Back to Top