Sign in
Schema recommendations

Get a schema recommendation

Authorization

A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

Service Token Accesses read_database

OAuth Scopes

ResourceScopes
Organizationread_databases
Databaseread_database
get/organizations/{organization}/databases/{database}/schema-recommendations/{number}

Path parameters

organizationstring required

Organization name slug from list_organizations. Example: acme.

databasestring required

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

numberinteger required

Schema recommendation sequence number. Example: 42.

Response

Returns a schema recommendation

idstring required

The ID of the schema recommendation

html_urlstring required

The URL to the schema recommendation in the app

titlestring required

The title of the schema recommendation

table_namestring required

The name of the table the recommendation applies to

keyspacestring required

The keyspace the recommendation applies to

ddl_statementstring required

The DDL statement to apply the recommendation

numberinteger required

The number of the schema recommendation

state'open' | 'applied' | 'dismissed' | 'stale' required

The state of the recommendation

recommendation_type'unused_table' | 'unused_index' | 'duplicate_index' | 'sequence_overflow' | 'sequence_overflow_foreign_key' | 'new_index' | 'encoding_upgrade' | 'bloated_table' | 'bloated_index' required

The type of recommendation

created_atstring required

When the recommendation was created

updated_atstring required

When the recommendation was last updated

applied_atstring nullable required

When the recommendation was applied

dismissed_atstring nullable required

When the recommendation was dismissed

Changes

Changed in 2 of the 24 revisions of this API.41

  • 72506953f3674See the full diff
    • ▲

      the response property applied_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property closed_by_deploy_request became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property dismissed_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property dismissed_by became nullable for the status 200

      response-property-became-nullable

  • ed1825db11c61See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog