Sentry · JSON Structure
Sentry Issue Structure
Structural documentation for the Sentry Issue resource — the core entity representing an aggregation of similar error events
Type:
Properties: 0
Error MonitoringDebuggingObservabilityApplication Performance ManagementDeveloper Tools
Sentry Issue Structure is a JSON Structure definition published by Sentry.
Meta-schema:
JSON Structure
{
"title": "Sentry Issue Structure",
"description": "Structural documentation for the Sentry Issue resource — the core entity representing an aggregation of similar error events",
"version": "0",
"source": "https://docs.sentry.io/api/events/list-a-projects-issues/",
"fields": [
{
"name": "id",
"type": "string",
"required": true,
"description": "Unique numeric identifier for the issue (as a string)"
},
{
"name": "shortId",
"type": "string",
"required": false,
"format": "ORG-NNN",
"description": "Human-readable short identifier in ORG-NNN format, e.g. MYORG-42"
},
{
"name": "title",
"type": "string",
"required": true,
"description": "Issue title composed of the exception type and message"
},
{
"name": "culprit",
"type": "string",
"required": false,
"description": "Module or function identified as the root cause"
},
{
"name": "permalink",
"type": "string",
"format": "uri",
"required": false,
"description": "Direct URL to the issue in the Sentry web UI"
},
{
"name": "logger",
"type": "string",
"nullable": true,
"description": "Logger name that captured the error"
},
{
"name": "level",
"type": "string",
"enum": ["fatal", "error", "warning", "info", "debug"],
"required": false,
"description": "Severity level of the issue"
},
{
"name": "status",
"type": "string",
"enum": ["resolved", "unresolved", "ignored", "resolvedInNextRelease"],
"required": true,
"description": "Current triage status of the issue"
},
{
"name": "isPublic",
"type": "boolean",
"description": "Whether the issue is shared publicly via permalink"
},
{
"name": "platform",
"type": "string",
"description": "SDK platform string (python, javascript, java, dotnet, go, ruby, etc.)"
},
{
"name": "project",
"type": "object",
"description": "Reference to the Sentry project the issue belongs to",
"fields": [
{"name": "id", "type": "string", "required": true},
{"name": "name", "type": "string", "required": true},
{"name": "slug", "type": "string", "required": true},
{"name": "platform", "type": "string"}
]
},
{
"name": "type",
"type": "string",
"enum": ["error", "csp", "hpkp", "expectct", "expectstaple", "default"],
"description": "Issue type category"
},
{
"name": "metadata",
"type": "object",
"description": "Issue-type-specific metadata",
"fields": [
{"name": "type", "type": "string", "description": "Exception class name"},
{"name": "value", "type": "string", "description": "Exception message text"},
{"name": "filename", "type": "string", "description": "Source filename"},
{"name": "function", "type": "string", "description": "Function or method name"}
]
},
{
"name": "numComments",
"type": "integer",
"minimum": 0,
"description": "Number of comments on this issue"
},
{
"name": "userCount",
"type": "integer",
"minimum": 0,
"description": "Number of distinct users who experienced this issue"
},
{
"name": "count",
"type": "string",
"description": "Total event count (returned as string for large numbers)"
},
{
"name": "firstSeen",
"type": "string",
"format": "date-time",
"required": true,
"description": "ISO 8601 timestamp of the first event for this issue"
},
{
"name": "lastSeen",
"type": "string",
"format": "date-time",
"required": true,
"description": "ISO 8601 timestamp of the most recent event"
},
{
"name": "assignedTo",
"type": "object",
"nullable": true,
"description": "The user or team assigned to this issue",
"fields": [
{"name": "type", "type": "string", "enum": ["user", "team"]},
{"name": "id", "type": "string"},
{"name": "name", "type": "string"},
{"name": "email", "type": "string", "format": "email"}
]
},
{
"name": "tags",
"type": "array",
"description": "Tag aggregations for this issue (browser, environment, release, etc.)",
"items": {
"type": "object",
"fields": [
{"name": "key", "type": "string", "required": true},
{"name": "name", "type": "string", "required": true},
{"name": "totalValues", "type": "integer"}
]
}
},
{
"name": "stats",
"type": "object",
"description": "Event count statistics keyed by period ('24h', '14d'). Values are arrays of [timestamp, count] pairs."
},
{
"name": "priority",
"type": "string",
"enum": ["critical", "high", "medium", "low"],
"description": "Issue priority level"
},
{
"name": "isSubscribed",
"type": "boolean",
"description": "Whether the current user is subscribed to notifications for this issue"
},
{
"name": "isBookmarked",
"type": "boolean",
"description": "Whether the current user has bookmarked this issue"
}
]
}