Traceable API Entity is a JSON Structure definition published by Traceable.
{
"name": "Traceable API Entity",
"description": "Structure of a discovered API entity in the Traceable platform",
"fields": [
{ "name": "id", "type": "string", "description": "Unique entity identifier" },
{ "name": "name", "type": "string", "description": "API endpoint path" },
{ "name": "entityType", "type": "string", "description": "Entity type classification", "enum": ["API", "SERVICE", "DOMAIN", "BACKEND", "ACTOR", "BACKEND_API"] },
{ "name": "service", "type": "string", "description": "Owning service" },
{ "name": "domain", "type": "string", "description": "Domain classification" },
{ "name": "method", "type": "string", "description": "HTTP method" },
{ "name": "authenticated", "type": "boolean", "description": "Requires authentication" },
{ "name": "authType", "type": "string", "description": "Authentication type" },
{ "name": "riskScore", "type": "string", "description": "Risk level", "enum": ["LOW", "MEDIUM", "HIGH", "CRITICAL"] },
{ "name": "isInternal", "type": "boolean", "description": "Internal endpoint flag" },
{ "name": "discoveryState", "type": "string", "enum": ["DISCOVERED", "UNDER_DISCOVERY"] },
{ "name": "lastActivity", "type": "datetime", "description": "Last observed activity" },
{ "name": "callVolume", "type": "integer", "description": "Observed call count" },
{ "name": "errorRate", "type": "number", "description": "Error rate percentage" },
{ "name": "latencyP99", "type": "number", "description": "99th percentile latency (ms)" },
{
"name": "labels", "type": "array", "description": "User-assigned labels",
"items": { "type": "string" }
},
{
"name": "attributes", "type": "array", "description": "Key-value attribute pairs",
"items": {
"fields": [
{ "name": "key", "type": "string" },
{ "name": "value", "type": "string" }
]
}
}
]
}