Skip to main content
GET
Get a schema recommendation

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organization
string
required

Organization name slug from list_organizations. Example: acme.

database
string
required

Database name slug from list_databases. Example: app-db.

number
integer
required

Schema recommendation sequence number. Example: 42.

Response

Returns a schema recommendation

id
string
required

The ID of the schema recommendation

html_url
string
required

The URL to the schema recommendation in the app

title
string
required

The title of the schema recommendation

table_name
string
required

The name of the table the recommendation applies to

keyspace
string
required

The keyspace the recommendation applies to

ddl_statement
string
required

The DDL statement to apply the recommendation

number
integer
required

The number of the schema recommendation

state
enum<string>
required

The state of the recommendation

Available options:
open,
applied,
dismissed,
stale
recommendation_type
enum<string>
required

The type of recommendation

Available options:
unused_table,
unused_index,
duplicate_index,
sequence_overflow,
sequence_overflow_foreign_key,
new_index,
encoding_upgrade,
bloated_table,
bloated_index
created_at
string
required

When the recommendation was created

updated_at
string
required

When the recommendation was last updated

applied_at
string | null
required

When the recommendation was applied

dismissed_at
string | null
required

When the recommendation was dismissed

closed_by_deploy_request
object | null
required
dismissed_by
object | null
required