API ReferenceMonitoring API

Monitoring API

Monitoring management endpoints

Auto-generated from OpenAPI spec on 2025-10-02


GET /metrics

GET metrics

🔒 Authentication Required: Bearer token

Parameters

NameTypeRequiredDescription
orgIdqueryYesOrganization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/metrics \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

GET /monitoring/webhooks

GET webhooks

Parameters

NameTypeRequiredDescription
orgIdqueryYesOrganization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/monitoring/webhooks \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

POST /monitoring/webhooks

POST webhooks

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X POST https://api.syaala.com/monitoring/webhooks \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

PUT /monitoring/webhooks

PUT webhooks

Request Body

{}

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X PUT https://api.syaala.com/monitoring/webhooks \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

DELETE /monitoring/webhooks

DELETE webhooks

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X DELETE https://api.syaala.com/monitoring/webhooks \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

GET /monitoring/metrics

GET metrics

🔒 Authentication Required: Bearer token

Parameters

NameTypeRequiredDescription
orgIdqueryYesOrganization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/monitoring/metrics \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

GET /monitoring/analytics

GET analytics

🔒 Authentication Required: Bearer token

Parameters

NameTypeRequiredDescription
orgIdqueryYesOrganization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/monitoring/analytics \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

GET /metrics/internal

GET internal

Parameters

NameTypeRequiredDescription
orgIdqueryYesOrganization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/metrics/internal \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"

GET /dashboard/metrics

GET metrics

🔒 Authentication Required: Bearer token

Parameters

NameTypeRequiredDescription
orgIdqueryYesOrganization ID

Responses

200 - Successful response

{}

400 - Bad request

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

401 - Unauthorized

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

404 - Not found

{
  "error": "string",
  "message": "string",
  "code": "string",
  "statusCode": 0
}

Examples

curl -X GET https://api.syaala.com/dashboard/metrics \\
  -H "Authorization: Bearer ${SYAALA_API_KEY}" \\
  -H "Content-Type: application/json"