Skip to content

HomepageApi.md

Latest commit

 

History

History
524 lines (352 loc) · 12.6 KB

HomepageApi.md

File metadata and controls

524 lines (352 loc) · 12.6 KB

LookerApi30Reference.HomepageApi

All URIs are relative to https://madisonreed.looker.com:19999/api/3.0

Method HTTP request Description
allHomepageItems GET /homepage_items Get All Homepage Items
allHomepageSections GET /homepage_sections Get All Homepage sections
createHomepageItem POST /homepage_items Create Homepage Item
createHomepageSection POST /homepage_sections Create Homepage section
deleteHomepageItem DELETE /homepage_items/{homepage_item_id} Delete Homepage Item
deleteHomepageSection DELETE /homepage_sections/{homepage_section_id} Delete Homepage section
homepageItem GET /homepage_items/{homepage_item_id} Get Homepage Item
homepageSection GET /homepage_sections/{homepage_section_id} Get Homepage section
updateHomepageItem PATCH /homepage_items/{homepage_item_id} Update Homepage Item
updateHomepageSection PATCH /homepage_sections/{homepage_section_id} Update Homepage section

allHomepageItems

[HomepageItem] allHomepageItems(opts)

Get All Homepage Items

Get information about all homepage items.

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.HomepageApi()

var opts = { 
  'fields': "fields_example", // {String} Requested fields.
  'sorts': "sorts_example", // {String} Fields to sort by.
  'homepageSectionId': "homepageSectionId_example" // {String} Filter to a specific homepage section
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.allHomepageItems(opts, callback);

Parameters

Name Type Description Notes
fields String Requested fields. [optional]
sorts String Fields to sort by. [optional]
homepageSectionId String Filter to a specific homepage section [optional]

Return type

[HomepageItem]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

allHomepageSections

[HomepageSection] allHomepageSections(opts)

Get All Homepage sections

Get information about all homepage sections.

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.HomepageApi()

var opts = { 
  'fields': "fields_example", // {String} Requested fields.
  'sorts': "sorts_example" // {String} Fields to sort by.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.allHomepageSections(opts, callback);

Parameters

Name Type Description Notes
fields String Requested fields. [optional]
sorts String Fields to sort by. [optional]

Return type

[HomepageSection]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createHomepageItem

HomepageItem createHomepageItem(opts)

Create Homepage Item

Create a new homepage item.

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.HomepageApi()

var opts = { 
  'body': new LookerApi30Reference.HomepageItem(), // {HomepageItem} Homepage Item
  'fields': "fields_example" // {String} Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createHomepageItem(opts, callback);

Parameters

Name Type Description Notes
body HomepageItem Homepage Item [optional]
fields String Requested fields. [optional]

Return type

HomepageItem

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createHomepageSection

HomepageSection createHomepageSection(opts)

Create Homepage section

Create a new homepage section.

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.HomepageApi()

var opts = { 
  'body': new LookerApi30Reference.HomepageSection(), // {HomepageSection} Homepage section
  'fields': "fields_example" // {String} Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createHomepageSection(opts, callback);

Parameters

Name Type Description Notes
body HomepageSection Homepage section [optional]
fields String Requested fields. [optional]

Return type

HomepageSection

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteHomepageItem

'String' deleteHomepageItem(homepageItemId)

Delete Homepage Item

Delete a homepage item.

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.HomepageApi()

var homepageItemId = 789; // {Integer} Id of homepage_item


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteHomepageItem(homepageItemId, callback);

Parameters

Name Type Description Notes
homepageItemId Integer Id of homepage_item

Return type

'String'

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteHomepageSection

'String' deleteHomepageSection(homepageSectionId)

Delete Homepage section

Delete a homepage section.

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.HomepageApi()

var homepageSectionId = 789; // {Integer} Id of homepage_section


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteHomepageSection(homepageSectionId, callback);

Parameters

Name Type Description Notes
homepageSectionId Integer Id of homepage_section

Return type

'String'

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

homepageItem

HomepageItem homepageItem(homepageItemId, opts)

Get Homepage Item

Get information about a homepage item.

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.HomepageApi()

var homepageItemId = 789; // {Integer} Id of homepage item

var opts = { 
  'fields': "fields_example" // {String} Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.homepageItem(homepageItemId, opts, callback);

Parameters

Name Type Description Notes
homepageItemId Integer Id of homepage item
fields String Requested fields. [optional]

Return type

HomepageItem

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

homepageSection

HomepageSection homepageSection(homepageSectionId, opts)

Get Homepage section

Get information about a homepage section.

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.HomepageApi()

var homepageSectionId = 789; // {Integer} Id of homepage section

var opts = { 
  'fields': "fields_example" // {String} Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.homepageSection(homepageSectionId, opts, callback);

Parameters

Name Type Description Notes
homepageSectionId Integer Id of homepage section
fields String Requested fields. [optional]

Return type

HomepageSection

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateHomepageItem

HomepageItem updateHomepageItem(homepageItemId, body, opts)

Update Homepage Item

Update a homepage item definition.

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.HomepageApi()

var homepageItemId = 789; // {Integer} Id of homepage item

var body = new LookerApi30Reference.HomepageItem(); // {HomepageItem} Homepage Item

var opts = { 
  'fields': "fields_example" // {String} Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateHomepageItem(homepageItemId, body, opts, callback);

Parameters

Name Type Description Notes
homepageItemId Integer Id of homepage item
body HomepageItem Homepage Item
fields String Requested fields. [optional]

Return type

HomepageItem

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateHomepageSection

HomepageSection updateHomepageSection(homepageSectionId, body, opts)

Update Homepage section

Update a homepage section definition.

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.HomepageApi()

var homepageSectionId = 789; // {Integer} Id of homepage section

var body = new LookerApi30Reference.HomepageSection(); // {HomepageSection} Homepage section

var opts = { 
  'fields': "fields_example" // {String} Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateHomepageSection(homepageSectionId, body, opts, callback);

Parameters

Name Type Description Notes
homepageSectionId Integer Id of homepage section
body HomepageSection Homepage section
fields String Requested fields. [optional]

Return type

HomepageSection

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json