DB24 Datastore – API Views Reference

The api schema exposes a set of version-controlled views designed as the stable, supported interface for external integrations. These views provide safe, read-only access to curated DB24 data without risk of breaking changes.

Use the synonym (without _vX suffix) to always target the latest version of each view.

Customers building integrations should always consume data through these views. The contract of each version is guaranteed — columns and semantics will not change within a version.

Overview

View	Description	Since	Status
AiQ_InstanceScores	Overall AiQ score per instance over time	2026.1	Active
AiQ_InstanceScores_Latest	Most recent AiQ instance scores	2026.1	Active
AiQ_MainCategoryScores	AiQ scores by main category over time	2026.1	Active
AiQ_MainCategoryScores_Latest	Most recent main category scores	2026.1	Active
AiQ_ParameterScores	Granular AiQ scores at parameter level	2026.1	Active
AiQ_ParameterScores_Latest	Most recent parameter scores	2026.1	Active
AiQ_SubCategoryScores	AiQ scores by sub-category over time	2026.1	Active
AiQ_SubCategoryScores_Latest	Most recent sub-category scores	2026.1	Active
Alerts	Runtime warnings and errors from DB24	2026.1	Active
Backups	Full backup history across all vendors	2026.1	Active
BackupStatus	Per-database latest backup status	2026.1	Active
Changes	DDL change tracking	2026.1	Active
Connections	Sampled connection info with activity metrics	2026.2	Active
Connections_v1	Per-snapshot connection details	2026.1	Deprecated (2026.2)
DatabaseEngagement	Last known data access per database	2026.1	Active
DatabaseUsers	Database-level users, roles and permissions	2026.1	Active
Databases	Database files and properties	2026.1	Active
DB24BackupErrors	Backup errors captured by extended events	2026.1	Active
Instances	Comprehensive instance metadata	2026.1	Active
Jobs	SQL Server Agent jobs and schedules	2026.1	Active
JobRuns	Job execution history	2026.1	Active
KeyValue	Custom key-value metadata on instances/databases	2026.1	Active
LifeCycleAdvisor	Version lifecycle and Microsoft support status	2026.1	Active
Logins	Server-level logins, roles and permissions	2026.1	Active
MaintenanceLogs	Unified maintenance operation log	2026.1	Active
PatchAdvisor	Recommended patch targets per instance	2026.1	Active
SQLErrorLogs	Raw SQL Server error log entries	2026.1	Active
SQLErrorLogsByDay	Aggregated error log counts per day	2026.1	Active
Tags	Tags assigned to instances and databases	2026.1	Active
Volumes	Current disk volume information	2026.1	Active
VolumeHistory	Historical volume capacity over time	2026.1	Active

View Details

api.AiQ_InstanceScores

Overall AiQ score per instance over time. Use the _Latest variant for current scores only.

Version	View name	Status	Usage
v1	`api.AiQ_InstanceScores_v1`	Active	`SELECT * FROM api.AiQ_InstanceScores`

Column	Description
`InstanceId`	Internal instance identifier
`InstanceName`	Display name of the SQL Server instance
`Score`	Calculated AiQ instance score
`Timestamp`	When the score was recorded

api.AiQ_InstanceScores_Latest

Convenience view returning only the most recent AiQ instance scores. Same columns as AiQ_InstanceScores (excluding Id).

Version	View name	Status	Usage
v1	`api.AiQ_InstanceScores_Latest_v1`	Active	`SELECT * FROM api.AiQ_InstanceScores_Latest`

api.AiQ_MainCategoryScores

AiQ scores broken down by main category per instance over time.

Version	View name	Status	Usage
v1	`api.AiQ_MainCategoryScores_v1`	Active	`SELECT * FROM api.AiQ_MainCategoryScores`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`Name`	Main category name
`Score`	Category score
`Weight`	Category weight in the overall calculation
`Description`	Category description
`Timestamp`	When the score was recorded

api.AiQ_MainCategoryScores_Latest

Most recent main category scores only. Same columns as AiQ_MainCategoryScores (excluding Id).

Version	View name	Status	Usage
v1	`api.AiQ_MainCategoryScores_Latest_v1`	Active	`SELECT * FROM api.AiQ_MainCategoryScores_Latest`

api.AiQ_ParameterScores

Granular AiQ scores at the individual parameter level, including category hierarchy.

Version	View name	Status	Usage
v1	`api.AiQ_ParameterScores_v1`	Active	`SELECT * FROM api.AiQ_ParameterScores`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`MainCategoryName`	Parent main category
`SubCategoryName`	Parent sub category
`Name`	Parameter name
`Score`	Parameter score
`Weight`	Parameter weight
`Description`	Parameter description
`Instructions`	Remediation / improvement guidance
`Critical`	Whether this parameter is flagged as critical
`ParameterId` / `MainCategoryId` / `SubCategoryId`	Foreign key references
`Timestamp`	When the score was recorded

api.AiQ_ParameterScores_Latest

Most recent parameter scores only. Same columns as AiQ_ParameterScores (excluding Id).

Version	View name	Status	Usage
v1	`api.AiQ_ParameterScores_Latest_v1`	Active	`SELECT * FROM api.AiQ_ParameterScores_Latest`

api.AiQ_SubCategoryScores

AiQ scores at the sub-category level per instance over time.

Version	View name	Status	Usage
v1	`api.AiQ_SubCategoryScores_v1`	Active	`SELECT * FROM api.AiQ_SubCategoryScores`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`MainCategoryName`	Parent main category
`Name`	Sub category name
`Score`	Sub category score
`Weight`	Sub category weight
`Description`	Sub category description
`MainCategoryId`	Foreign key to main category
`Timestamp`	When the score was recorded

api.AiQ_SubCategoryScores_Latest

Most recent sub-category scores only. Same columns as AiQ_SubCategoryScores (excluding Id).

Version	View name	Status	Usage
v1	`api.AiQ_SubCategoryScores_Latest_v1`	Active	`SELECT * FROM api.AiQ_SubCategoryScores_Latest`

api.Alerts

Runtime alerts (warnings and errors) from the DB24 log.

Version	View name	Status	Usage
v1	`api.Alerts_v1`	Active	`SELECT * FROM api.Alerts`

Column	Description
`Id`	Alert identifier
`InstanceId` / `InstanceName`	Instance identifiers
`Timestamp`	When the alert was logged
`LogLevel`	`Warning` or `Error`
`ObjectName`	Source object that raised the alert
`Message`	Alert message text
`Severity` / `State` / `ErrorCode`	SQL Server error metadata
`LineNumber`	Line number in the source object
`AdditionalInfo`	Extra context, if available

api.Backups

Full backup history across all vendors (native, third-party).

Version	View name	Status	Usage
v1	`api.Backups_v1`	Active	`SELECT * FROM api.Backups`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`DbName`	Database name
`Vendor` / `VendorDescription`	Backup tool used
`BackupType`	Full, Differential, Log, etc.
`BackupStart` / `BackupFinish`	Backup time window
`DurationMin`	Duration in minutes
`BackupSizeMB` / `CompressedBackupSizeMB`	Size metrics
`BackupFile`	Backup file path
`IsCompressed` / `IsCopyOnly` / `IsSnapshot` / `IsEncrypted` / `IsDamaged`	Backup flags

api.BackupStatus

Per-database backup status showing the latest backup of any type and the latest full backup. Only includes online, non-tempdb databases seen within the last month.

Version	View name	Status	Usage
v1	`api.BackupStatus_v1`	Active	`SELECT * FROM api.BackupStatus`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`DbId` / `DbName`	Database identifiers
`RecoveryModel` / `ReadOnly`	Database properties
`IsExcluded`	Whether the database is excluded from backup monitoring
`BackupStart` / `DaysSinceLastBackup`	Latest backup (any type)
`BackupSize` / `CompressedBackupSize` / `BackupFile` / `BackupType`	Latest backup details
`LastFullBackupStart` / `DaysSinceLastFullBackup`	Latest full backup
`LastFullBackupSize` / `LastFullCompressedBackupSize` / `LastFullBackupFile`	Full backup details

api.Changes

DDL change tracking — schema and object changes captured from monitored instances.

Version	View name	Status	Usage
v1	`api.Changes_v1`	Active	`SELECT * FROM api.Changes`

Column	Description
`Id`	Change record identifier
`EventDate`	When the change occurred
`InstanceId` / `InstanceName`	Instance identifiers
`DbName`	Database where the change occurred
`ObjectType` / `ObjectName`	Changed object
`EventType`	Type of DDL event (e.g. `ALTER_TABLE`)
`LoginName`	Who made the change
`Command`	The DDL command executed

api.Connections

Sampled connection information with activity metrics per connection over time.

Version	View name	Status	Usage
v1	`api.Connections_v1`	Deprecated (2026.2)	`SELECT * FROM api.Connections_v1`
v2	`api.Connections_v2`	Active	`SELECT * FROM api.Connections`

Connections_v1 was introduced in 2026.1 and is deprecated as of 2026.2. It exposed per-snapshot connection details including CommandType, CommandDetail, RowCount, Reads, Writes, CPUTimeMs, and TotalTimeMs. Migrate to Connections_v2 for the new sampling-based structure.

Column	Description
`Id`	Connection record identifier
`InstanceId` / `InstanceName`	Instance identifiers
`EventDateDay`	Date partition
`ConnectionId` / `SPID`	SQL Server connection identifiers
`FirstSeenAt` / `LastSeenAt`	Connection lifetime window
`SampleCount` / `ActiveSampleCount` / `IdleSampleCount` / `ActiveSamplePct`	Activity sampling metrics
`IsSqlServerInternal`	Whether the connection is internal to SQL Server
`Login`	Login name (defaults to `null / empty` if blank)
`RemoteHostName` / `RemoteIPAddress` / `RemoteTCPPort`	Remote endpoint
`LocalIPAddress` / `LocalTCPPort`	Local endpoint
`NetworkProtocol` / `AuthenticationScheme` / `EncryptedConnection`	Connection properties
`DatabaseName` / `Program` / `JobName`	Session context
`LastStatus`	Last observed connection status

api.DatabaseEngagement

Shows last known data access per database, useful for identifying unused databases. System databases are excluded.

Version	View name	Status	Usage
v1	`api.DatabaseEngagement_v1`	Active	`SELECT * FROM api.DatabaseEngagement`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`DbName`	Database name
`State`	Database state
`LastUsedTable`	Schema-qualified table name of last access (`No activity recorded` if none)
`LastDataAccess`	Date of last recorded data access
`NotUsedSinceDays`	Days since last access (`-1` if no activity recorded)

api.DatabaseUsers

Database-level users with their roles and permissions.

Version	View name	Status	Usage
v1	`api.DatabaseUsers_v1`	Active	`SELECT * FROM api.DatabaseUsers`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`DbName`	Database name
`UserName`	Database user name
`IsDBOwner`	Whether the user is the database owner
`TypeDesc`	User type
`CreateDate` / `ModifyDate`	User metadata
`DBUserRoles`	Assigned database roles
`GrantedPermissions` / `GrantedWithPermissions` / `DeniedPermissions`	Permission sets
`Timestamp`	Data collection timestamp

api.Databases

Database files and properties across all monitored instances.

Version	View name	Status	Usage
v1	`api.Databases_v1`	Active	`SELECT * FROM api.Databases`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`DbId` / `DbName`	Database identifiers
`LogicalFileName` / `PhysicalFileName` / `Volume`	File location
`Type` / `FileId`	File type (rows/log) and file ID
`State` / `UserAccess` / `RecoveryModel` / `CompatLevel`	Database settings
`FileSizeMB` / `SpaceUsedMB` / `SpaceFreeMB` / `SpaceFreePercent`	Space metrics
`Collation` / `ReadOnly` / `AutoClose` / `AutoShrink` / `PageVerify`	Configuration flags
`IsEncryptionOn` / `EncryptionKey` / `EncryptionCertificate`	Encryption details
`Timestamp`	Data collection timestamp

api.DB24BackupErrors

Backup-related errors captured by DB24's extended events.

Version	View name	Status	Usage
v1	`api.DB24BackupErrors_v1`	Active	`SELECT * FROM api.DB24BackupErrors`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`DbId` / `DbName`	Database identifiers
`EventName` / `EventTime`	Event metadata
`ErrorNumber` / `Message`	Error details
`SqlText`	The SQL statement that caused the error

api.Instances

Comprehensive instance-level information — the primary entry point for instance metadata.

Version	View name	Status	Usage
v1	`api.Instances_v1`	Active	`SELECT * FROM api.Instances`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`Status` / `LastSuccessfulPing`	Monitoring status
`ServerName` / `MachineName` / `Platform`	Host information
`InstallationDate` / `LastRestart`	Instance lifecycle
`MajorVersion` / `ProductVersion` / `SQLServerVersion` / `Edition`	Version info
`IsSupported`	Whether the SQL Server version is currently supported
`VersionReleaseDate` / `DaysSinceRelease`	Patch age
`DatabaseCount`	Number of databases on the instance
`InstanceSizeGB`	Total instance size
`Cores` / `PhysCPU` / `MAXDOP` / `CostThresholdForParallellism`	CPU configuration
`MinMemMB` / `MaxMemMB` / `OSRAMMB`	Memory configuration
`IsClustered` / `ActiveNode` / `IsHADREnabled`	High availability
`AuthenticationMode` / `AuditLevel` / `IsSALoginEnabled`	Security settings
`InstanceScore` / `InstanceScore4WeeksAgo` / `InstanceScoreFirst`	AiQ score trend
`SystemVersionCode`	DB24 agent version
`Timestamp`	Data collection timestamp

This view includes many additional columns for detailed configuration and security posture. See the full column list in the SQL definition.

api.Jobs

SQL Server Agent jobs and their schedules. Returns the latest snapshot per job.

Version	View name	Status	Usage
v1	`api.Jobs_v1`	Active	`SELECT * FROM api.Jobs`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`JobName`	Job name
`JobEnabled` / `ScheduleEnabled`	Enable flags
`ScheduleName` / `Frequency` / `SubnFrequency`	Schedule definition
`StartTime` / `EndTime` / `NextRunDate` / `NextRunTime`	Timing
`MaxDurationMinutes` / `MinDurationMinutes` / `AvgDurationMinutes`	Historical duration stats
`FailNotifyName` / `FailNotifyEmail`	Failure notification config
`Timestamp`	Data collection timestamp

api.JobRuns

Job execution history with run status and messages.

Version	View name	Status	Usage
v1	`api.JobRuns_v1`	Active	`SELECT * FROM api.JobRuns`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`JobName` / `JobId`	Job identifiers
`Enabled`	Whether the job is enabled
`Description`	Job description
`DateCreated` / `DateModified`	Job metadata
`LastRunDate` / `LastRunStatus`	Most recent run
`Message`	Run result message

api.KeyValue

Custom key-value metadata attached to instances or databases.

Version	View name	Status	Usage
v1	`api.KeyValue_v1`	Active	`SELECT * FROM api.KeyValue`

Column	Description
`Id`	Record identifier
`Key` / `Value`	The key-value pair
`InstanceId` / `InstanceName`	Instance identifiers
`DbId` / `DbName`	Database identifiers (nullable — instance-level if null)

api.LifeCycleAdvisor

SQL Server version lifecycle and Microsoft support status per instance.

Version	View name	Status	Usage
v1	`api.LifeCycleAdvisor_v1`	Active	`SELECT * FROM api.LifeCycleAdvisor`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`Edition`	SQL Server edition
`InstallationDate`	When SQL Server was installed
`SQLServerVersion` / `VersionReleased`	Installed version and its release date
`MicrosoftMainstreamSupportEnds`	End of Microsoft mainstream support
`MicrosoftSupported`	`1` if currently supported, `0` otherwise

api.Logins

Server-level logins with roles, permissions, and password policy status.

Version	View name	Status	Usage
v1	`api.Logins_v1`	Active	`SELECT * FROM api.Logins`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`LoginName` / `TypeDesc`	Login name and type
`IsSysadmin` / `IsDisabled`	Privilege and status flags
`ServerRoles`	Assigned server roles
`GrantedPermissions` / `GrantedWithPermissions` / `DeniedPermissions`	Permission sets
`EnforcedPasswordPolicy` / `EnforcedPasswordExpiration`	Password policy status
`Timestamp`	Data collection timestamp

api.MaintenanceLogs

Unified maintenance log combining index rebuilds/reorgs, integrity checks, statistics updates, and size protection operations.

Version	View name	Status	Usage
v1	`api.MaintenanceLogs_v1`	Active	`SELECT * FROM api.MaintenanceLogs`

Column	Description
`Id`	Log entry identifier
`InstanceId` / `InstanceName`	Instance identifiers
`DbId` / `DbName`	Database identifiers
`SchemaName` / `ObjectType` / `ObjectName`	Target object
`IndexType` / `IndexName` / `StatisticsName`	Index or statistics target
`Partition`	Partition number
`MaintenanceType`	Type of maintenance performed
`Command`	The maintenance command executed
`StartTime` / `EndTime` / `DurationMinutes`	Timing
`Notes`	Additional info from the maintenance engine
`ErrorNumber` / `ErrorMessage`	Error details (if failed)

api.PatchAdvisor

Recommended patch targets per instance based on the currently installed version.

Version	View name	Status	Usage
v1	`api.PatchAdvisor_v1`	Active	`SELECT * FROM api.PatchAdvisor`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`MajorVersion`	SQL Server major version
`InstalledPatch` / `InstalledPatchReleased` / `DaysLive`	Currently installed patch info
`TargetPatch` / `Description` / `WebLink`	Recommended patch
`TargetPatchReleased` / `TargetDaysLive`	Target patch age

api.SQLErrorLogs

Raw SQL Server error log entries.

Version	View name	Status	Usage
v1	`api.SQLErrorLogs_v1`	Active	`SELECT * FROM api.SQLErrorLogs`

Column	Description
`Id`	Record identifier
`InstanceId` / `InstanceName`	Instance identifiers
`ErrProcessInfo`	Process that generated the entry
`ErrLogEvtDate`	Event date from the error log
`ErrLogText`	Error log message text
`Timestamp`	Data collection timestamp

api.SQLErrorLogsByDay

Aggregated SQL Server error log counts per day and filter category.

Version	View name	Status	Usage
v1	`api.SQLErrorLogsByDay_v1`	Active	`SELECT * FROM api.SQLErrorLogsByDay`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`Filter`	Error category/filter
`CurrentDay`	Date (`YYYYMMDD`)
`MinEventDate` / `MaxEventDate`	Event date range for the day
`Counter`	Number of errors

api.Tags

Tags assigned to instances and databases for grouping and filtering.

Version	View name	Status	Usage
v1	`api.Tags_v1`	Active	`SELECT * FROM api.Tags`

Column	Description
`Id`	Tag record identifier
`Tag`	Tag value
`InstanceId` / `InstanceName`	Instance identifiers
`DbId` / `DbName`	Database identifiers (nullable — instance-level tag if null)

api.Volumes

Current disk volume information including SQL file placement.

Version	View name	Status	Usage
v1	`api.Volumes_v1`	Active	`SELECT * FROM api.Volumes`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`Volume` / `VolumeMountPoint` / `LogicalVolumeName` / `FileSystemType`	Volume identification
`TotalSizeMB` / `UsedSpaceMB` / `AvailableSpaceMB` / `FreeSpacePct`	Capacity
`HasSqlFiles` / `HasDataFiles` / `HasLogFiles`	SQL file presence
`DataFileCount` / `LogFileCount`	File counts
`DataFilesTotalSizeMB` / `LogFilesTotalSizeMB`	SQL file sizes
`Timestamp`	Data collection timestamp

api.VolumeHistory

Historical volume capacity over time — useful for growth trending and capacity planning.

Version	View name	Status	Usage
v1	`api.VolumeHistory_v1`	Active	`SELECT * FROM api.VolumeHistory`

Column	Description
`InstanceId` / `InstanceName`	Instance identifiers
`Volume`	Volume identifier
`TotalSizeMB` / `TotalSizeGB`	Total capacity
`AvailableSpaceMB` / `AvailableSpaceGB` / `FreeSpacePct`	Available space
`Timestamp`	Data collection timestamp