Loading

Data views API

Note: Kibana index patterns are currently being renamed to data views. There will be some naming inconsistencies until the transition is complete.

  • Get list of data views
  • Get default data view and examine fields
  • Get data view by id
  • Find data view by title
  • Create data view
  • Create data view and save it
  • Modify data view and save it
  • Delete data view
const idsAndTitles = await data.indexPatterns.getIdsWithTitle();
idsAndTitles.forEach(({id, title}) => console.log(`Data view id: ${id} title: ${title}`));
		
const defaultDataView = await data.indexPatterns.getDefault();
defaultDataView.fields.forEach(({name}) => { console.log(name); })
		
const id = 'xxxxxx-xxx-xxxxxx';
const dataView = await data.indexPatterns.get(id);
		
const title = 'kibana-*';
const [dataView] = await data.indexPatterns.find(title);
		
const dataView = await data.indexPatterns.create({ title: 'kibana-*' });
		
const dataView = await data.indexPatterns.createAndSave({ title: 'kibana-*' });
		
const dataView = await data.indexPatterns.create({ title: 'kibana-*' });
dataView.setFieldCustomLabel('customer_name', 'Customer Name');
data.indexPatterns.createSavedObject(dataView);
		
dataView.setFieldCustomLabel('customer_name', 'Customer Name');
await data.indexPatterns.updateSavedObject(dataView);
		
await data.indexPatterns.delete(dataViewId);

Rest-like HTTP CRUD+ API - docs

  • hasESData: () => Promise<boolean>; // Check to see if ES data exists
  • hasDataView: () => Promise<boolean>; // Check to see if any data view exists (managed or user created)
  • hasUserDataView: () => Promise<boolean>; // Check to see if user created data views exists