Sorry, we don't support your browser.  Install a modern browser

Export APIs

Nolt provides CSV and JSON APIs to export your board data in real-time. In this help article, we will describe how to use these APIs from a developer perspective.

If you are looking for simple spreadsheet integrations (Google Sheets, Microsoft Excel, Zoho Sheet), please refer to our spreadsheet exports help article.

CSV API

The CSV API allows you to export your board data in CSV format in real-time.

To access the CSV API, you need to know your board subdomain and your API key. You can provision and manage your API keys in your board settings. Simply send an HTTP GET request in the following format:

https://YOUR_BOARD.nolt.io/api/csv?apikey=YOUR_API_KEY

By default, the CSV API will return a CSV file with most of the columns and data you would expect, but it will not return the list of votes for each post or the list of comments for each post. If you wish to include these columns, you can add the &votes=true query parameter to your request to include votes, and the &comments=true query parameter to include comments.

Considering the drawbacks of including nested data in CSV files, we recommend using the JSON export API instead when you need comment and vote data.

The CSV format does not natively support nested data structures like votes and comments (each row is a post, so it is not possible to include multiple votes and comments in the same post row). If you choose to include votes and comments in your API request, they will be added as separate rows within and under each post row (the rest of the vote/comment rows will be empty). You should try a test export and carefully examine the format to make sure it works for your use case.

JSON API

Just like the CSV API, the JSON API allows you to export your board data in JSON format in real-time. JSON is a much more flexible format than CSV, so it is possible to include nested data structures like votes and comments without breaking things.

To access the JSON API, you need to know your board subdomain and your API key. You can provision and manage your API keys in your board settings. Simply send an HTTP GET request in the following format:

https://YOUR_BOARD.nolt.io/api/json?apikey=YOUR_API_KEY

Just like the CSV API, the JSON API will not return the list of votes for each post or the list of comments for each post by default. If you wish to include that data, add the &votes=true query parameter for votes, and the &comments=true query parameter for comments.

Related

Export to spreadsheets in real-time
Learn about our Google Sheets, Microsoft Excel, and Zoho Sheet integrations.