<img height="1" width="1" style="display:none" src="https://www.facebook.com/tr?id=749646578535459&amp;ev=PageView&amp;noscript=1">
Skip to content
  • There are no suggestions because the search field is empty.

XLSX Multi Chart Export API

An XLSX Chart Export API can be used to export Charts' data from KaiNexus.

Two Line OfieREQUIRED: Your organization must have the API Module enabled to perform the actions mentioned in this article. Reach out to your Customer Success Manager if you're interested in this module.

A Chart Export API call will export the data, including any Annotations, for all Charts in an Item List Card. This helps you take information stored in KaiNexus and export it to other software platforms. 

Customers often utilize Chart Export API to pull data from Charts in KaiNexus and enter it into a business analytics system.

Two Line OfieIf you want the Charts' details, like any of their fields, dates, or attributes, to be exported rather than their data, you can use a regular Item Export API instead. To learn about XLSX Item Export APIs, check out this support article. To learn about JSON Item Export APIs, check out this support article.

Two Line OfieWe strongly recommend using the JSON Chart Export API instead of the XLSX Chart Export API. To learn about the JSON Chart Export API, check out this support article.

How does it work? 

KaiNexus provides an endpoint where you can access Chart information. To make a call, you will need an API Key and an API tool. 

Ofie Profile PicImportant: If your organization uses the EU server, replace the base URL shown in this support page’s examples with the EU server URL.  

https://eu-prod.kainexus.com

Authentication

Calls to the KaiNexus API can be authenticated using either an API Key or OAuth 2.0. Both authentication methods use Credentials associated with a Service Account, which determines the data and actions those Credentials can access.

Before making API calls, you must create a Service Account and securely save its Credentials, as they cannot be viewed again after creation.

To authenticate with API Keys:

  • Set authentication type to Basic Auth.
  • Username: api
  • Password: Your API Key

To authenticate with OAuth 2.0, reference Authenticating with OAuth 2.0 for details on how to use the Client ID and Client Secret to generate a token.

Two Line OfieRequired: Make sure your API Key has been granted the necessary permission to "view" any Charts you want to export.

For an API to be able to export all Charts in KaiNexus, the View, View New, and View Private permissions need to be granted and set to "Everywhere" for all Workflows. Check out this support article for more information on each of these permissions.

Exporting Charts

After authentication, you can make your first XLSX Chart Export API call.

To export the data of all Charts from a specific Item List Card in XLSX format, execute a GET request to this URL: 

https://api.kainexus.com/api/public/v1/excel/chartList?id=XXXXX
  • Replace "xxxxx" with the Item List Card's ID.
  • You can find an Item List Card's ID by hovering over the Card's header. A tooltip will appear that shows the Card's ID.

An Item List Card. The Card's tooltip is visible and an arrow is pointing to the Card's ID.

  • Any non-Chart Items included on the Item List Card will be ignored and will not be included in the XLSX document.
  • If the Card includes fewer than 1,000 Charts, this call will retrieve a list of all its Charts in XLSX format. 
  • If the Card includes more than 1,000 Charts, this call will retrieve a list of its first 1,000 Charts.

Helpful Tips

  1. In XLSX format, there are separate worksheets for each Chart that will contain a column for each of its data series and a row for each data point.
  2. Each Chart will also have a second worksheet for its Annotations.