Skip to content

Latest commit

 

History

History
385 lines (254 loc) · 11.4 KB

RenderTaskApi.md

File metadata and controls

385 lines (254 loc) · 11.4 KB
Raw

LookerApi30Reference.RenderTaskApi

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

Method HTTP request Description
createDashboardRenderTask POST /render_tasks/dashboards/{dashboard_id}/{result_format} Create Dashboard Render Task
createLookRenderTask POST /render_tasks/looks/{look_id}/{result_format} Create Look Render Task
createLookmlDashboardRenderTask POST /render_tasks/lookml_dashboards/{dashboard_id}/{result_format} Create Lookml Dashboard Render Task
createQueryRenderTask POST /render_tasks/queries/{query_id}/{result_format} Create Query Render Task
renderTask GET /render_tasks/{render_task_id} Get Render Task
renderTaskResults GET /render_tasks/{render_task_id}/results Render Task Results

createDashboardRenderTask

RenderTask createDashboardRenderTask(dashboardId, resultFormat, body, width, height, opts)

Create Dashboard Render Task

Create a new task to render a dashboard to a document or image.

Returns a render task object. To check the status of a render task, pass the render_task.id to Get Render Task. Once the render task is complete, you can download the resulting document or image using Get Render Task Results.

Example

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

var apiInstance = new LookerApi30Reference.RenderTaskApi()

var dashboardId = 789; // {Integer} Id of dashboard to render

var resultFormat = "resultFormat_example"; // {String} Output type: pdf, png, or jpg

var body = new LookerApi30Reference.CreateDashboardRenderTask(); // {CreateDashboardRenderTask} Dashboard render task parameters

var width = 789; // {Integer} Output width in pixels

var height = 789; // {Integer} Output height in pixels

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.createDashboardRenderTask(dashboardId, resultFormat, body, width, height, opts, callback);

Parameters

Name Type Description Notes
dashboardId Integer Id of dashboard to render
resultFormat String Output type: pdf, png, or jpg
body CreateDashboardRenderTask Dashboard render task parameters
width Integer Output width in pixels
height Integer Output height in pixels
fields String Requested fields. [optional]

Return type

RenderTask

Authorization

No authorization required

HTTP request headers

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

createLookRenderTask

RenderTask createLookRenderTask(lookId, resultFormat, width, height, opts)

Create Look Render Task

Create a new task to render a look to an image.

Returns a render task object. To check the status of a render task, pass the render_task.id to Get Render Task. Once the render task is complete, you can download the resulting document or image using Get Render Task Results.

Example

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

var apiInstance = new LookerApi30Reference.RenderTaskApi()

var lookId = 789; // {Integer} Id of look to render

var resultFormat = "resultFormat_example"; // {String} Output type: png, or jpg

var width = 789; // {Integer} Output width in pixels

var height = 789; // {Integer} Output height in pixels

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.createLookRenderTask(lookId, resultFormat, width, height, opts, callback);

Parameters

Name Type Description Notes
lookId Integer Id of look to render
resultFormat String Output type: png, or jpg
width Integer Output width in pixels
height Integer Output height in pixels
fields String Requested fields. [optional]

Return type

RenderTask

Authorization

No authorization required

HTTP request headers

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

createLookmlDashboardRenderTask

RenderTask createLookmlDashboardRenderTask(dashboardId, resultFormat, body, width, height, opts)

Create Lookml Dashboard Render Task

Create a new task to render a lookml dashboard to a document or image.

Returns a render task object. To check the status of a render task, pass the render_task.id to Get Render Task. Once the render task is complete, you can download the resulting document or image using Get Render Task Results.

Example

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

var apiInstance = new LookerApi30Reference.RenderTaskApi()

var dashboardId = "dashboardId_example"; // {String} Id of lookml dashboard to render

var resultFormat = "resultFormat_example"; // {String} Output type: pdf, png, or jpg

var body = new LookerApi30Reference.CreateDashboardRenderTask(); // {CreateDashboardRenderTask} Dashboard render task parameters

var width = 789; // {Integer} Output width in pixels

var height = 789; // {Integer} Output height in pixels

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.createLookmlDashboardRenderTask(dashboardId, resultFormat, body, width, height, opts, callback);

Parameters

Name Type Description Notes
dashboardId String Id of lookml dashboard to render
resultFormat String Output type: pdf, png, or jpg
body CreateDashboardRenderTask Dashboard render task parameters
width Integer Output width in pixels
height Integer Output height in pixels
fields String Requested fields. [optional]

Return type

RenderTask

Authorization

No authorization required

HTTP request headers

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

createQueryRenderTask

RenderTask createQueryRenderTask(queryId, resultFormat, width, height, opts)

Create Query Render Task

Create a new task to render an existing query to an image.

Returns a render task object. To check the status of a render task, pass the render_task.id to Get Render Task. Once the render task is complete, you can download the resulting document or image using Get Render Task Results.

Example

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

var apiInstance = new LookerApi30Reference.RenderTaskApi()

var queryId = 789; // {Integer} Id of the query to render

var resultFormat = "resultFormat_example"; // {String} Output type: png or jpg

var width = 789; // {Integer} Output width in pixels

var height = 789; // {Integer} Output height in pixels

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.createQueryRenderTask(queryId, resultFormat, width, height, opts, callback);

Parameters

Name Type Description Notes
queryId Integer Id of the query to render
resultFormat String Output type: png or jpg
width Integer Output width in pixels
height Integer Output height in pixels
fields String Requested fields. [optional]

Return type

RenderTask

Authorization

No authorization required

HTTP request headers

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

renderTask

RenderTask renderTask(renderTaskId, opts)

Get Render Task

Get information about a render task.

Returns a render task object. To check the status of a render task, pass the render_task.id to Get Render Task. Once the render task is complete, you can download the resulting document or image using Get Render Task Results.

Example

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

var apiInstance = new LookerApi30Reference.RenderTaskApi()

var renderTaskId = "renderTaskId_example"; // {String} Id of render task

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.renderTask(renderTaskId, opts, callback);

Parameters

Name Type Description Notes
renderTaskId String Id of render task
fields String Requested fields. [optional]

Return type

RenderTask

Authorization

No authorization required

HTTP request headers

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

renderTaskResults

'String' renderTaskResults(renderTaskId)

Render Task Results

Get the document or image produced by a completed render task.

Returns 102 Processing if the render task has not completed.

Example

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

var apiInstance = new LookerApi30Reference.RenderTaskApi()

var renderTaskId = "renderTaskId_example"; // {String} Id of render task


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

Parameters

Name Type Description Notes
renderTaskId String Id of render task

Return type

'String'

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: image/jpeg, image/png, application/pdf