Support Center

dashboard

Last Updated: May 27, 2014 02:34PM CEST
API methods

createDatasource

delete

duplicate

get

getDatasources

reload

 


METHOD
 

dashboard / createDatasource

 

URL
 

https://jolicharts.com/api/dashboard/createDatasource
 

Description
 

Creates a new empty datasource in the dashboard using the provided datasource name. Returns the unique code of the created datasource.
 

HTTP Methods
 

GET, POST
 

Response formats
 

XML, JSON
 

Parameters
 

Private
  • datasourceName string
    The name of the datasource. Defaults to "New datasource". Optional.
 
Public
  • dashboard string
    Your dashboard API key. Mandatory.
  • lb bool
    Adds linebreaks to the XML string. Applies to XML strings only. Defaults to false. Optional.
  • format string
    Output format of the response. See response formats for available options. Defaults to xml. Optional.
 

Example
 

https://jolicharts.com/api/dashboard/createDatasource?dashboard=DASHBOARD_API_KEY&name=Sales
 

Response
 

No example formats found.

 

 

METHOD
 

dashboard / delete

 

URL
 

https://jolicharts.com/api/dashboard/delete
 

Description
 

Deletes the dashboard and all related elements.
 

HTTP Methods
 

GET, POST
 

Response formats
 

XML, JSON
 

Parameters
 

Public
  • dashboard string
    Your dashboard API key. Mandatory.
  • lb bool
    Adds linebreaks to the XML string. Applies to XML strings only. Defaults to false. Optional.
  • format string
    Output format of the response. See response formats for available options. Defaults to xml. Optional.
 

Example
 

https://jolicharts.com/api/dashboard/delete?dashboard=DASHBOARD_API_KEY
 

Response
 

No example formats found.



 


METHOD
 

dashboard / duplicate

 

URL
 

https://jolicharts.com/api/dashboard/duplicate
 

Description
 

Duplicates the dashboard and all its related elements (sheets, dashboard elements,...). Optionally it is possible to duplicate the data of the dashboard and the user rights. If the dashboard data is not duplicated, datasources will be duplicated but will not contain any files and the charts will remain empty. 
 

HTTP Methods
 

GET, POST
 

Response formats
 

XML, JSON
 

Parameters
 

Private
  • duplicateData bool
    Set this to true to duplicate all the data related to the dashboard. Defaults to false. Optional.
  • duplicateUsers bool
    Set this to true to duplicate dashboard related user rights. Defaults to false. Optional.
  • name string
    The name you'd like to give to the new dashboard. Defaults to "Copy of NAME_OF_DASHBOARD_TO_DUPLICATE". Optional.
 
Public
  • dashboard string
    Your dashboard API key. Mandatory.
  • lb bool
    Adds linebreaks to the XML string. Applies to XML strings only. Defaults to false. Optional.
  • format string
    Output format of the response. See response formats for available options. Defaults to xml. Optional.
 

Example
 

https://jolicharts.com/api/dashboard/duplicate?dashboard=DASHBOARD_API_KEY&data=true&users=true
 

Response
 

No example formats found.



 


METHOD
 

dashboard / get

 

URL
 

https://jolicharts.com/api/dashboard/get
 

Description
 

Gets information about the dashboard (unique URL, name, etc.)
 

HTTP Methods
 

GET, POST
 

Response formats
 

XML, JSON
 

Parameters
 

Public
  • dashboard string
    Your dashboard API key. Mandatory.
  • lb bool
    Adds linebreaks to the XML string. Applies to XML strings only. Defaults to false. Optional.
  • format string
    Output format of the response. See response formats for available options. Defaults to xml. Optional.
 

Example
 

https://jolicharts.com/api/dashboard/get?dashboard=DASHBOARD_API_KEY
 

Response
 

No example formats found.

 


METHOD
  

dashboard / getDatasources

 

URL
 

https://jolicharts.com/api/dashboard/getDatasources
 

Description
 

Gets all datasources related to a dashboard.
 

HTTP Methods
 

GET, POST
 

Response formats
 

XML, JSON
 

Parameters
 

Public
  • dashboard string
    Your dashboard API key. Mandatory.
  • lb bool
    Adds linebreaks to the XML string. Applies to XML strings only. Defaults to false. Optional.
  • format string
    Output format of the response. See response formats for available options. Defaults to xml. Optional.
 

Example
 

https://jolicharts.com/api/dashboard/getDatasources?dashboard=DASHBOARD_API_KEY
 

Response
 

No example formats found.

 



METHOD
 

dashboard / reload

 

URL
 

https://jolicharts.com/api/dashboard/reload
 

Description
 

Reloads all pending datasources belonging to a dashboard. Pending datasources are datasources which have files that have not been analysed or reloaded yet. 
 

HTTP Methods
 

GET, POST
 

Response formats
 

XML, JSON
 

Parameters
 

Public
  • dashboard string
    Your dashboard API key. Mandatory.
  • lb bool
    Adds linebreaks to the XML string. Applies to XML strings only. Defaults to false. Optional.
  • format string
    Output format of the response. See response formats for available options. Defaults to xml. Optional.
 

Example
 

https://jolicharts.com/api/dashboard/reload?dashboard=DASHBOARD_API_KEY
 

Response
 

No example formats found.

Contact Us

support@jolicharts.com
http://assets2.desk.com/
false
jolicharts
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete