Difference between revisions of "DataZoa API Examples"

Latest revision as of 10:40, 13 November 2020

The dataZoa API can be very handy for simple ad hoc tasks.

You can use the API without programming, just using your everyday browser. For example, to get all of the series keys for a grouplist, enter:

https://www.datazoa.com/api/apimain.asp?func=SeriesFromGL&glname=YourGroupName&apikey=YourAPIKey

in your browser's address bar. The results will require some reformatting, but it's fast and effective.

Perhaps even simpler, if you are comfortable with Windows commandline Powershell, you can you can just do this:

(curl "https://www.datazoa.com/api/apimain.asp?func=SeriesFromGL&glname=YourGroupName&apikey=YourAPIKey | ConvertFrom-Json).payload

Here are a few examples...

Example	Description
func=RunState&apikey=YourAPIKey	API Healthcheck
func=SeriesGet&serieskey=YourAccount/00004321&apikey=YourAPIKey&payloadasjson=true	Get a Series, return result payload as JSON
func=SeriesFromGL&glname=YourGroupName&apikey=YourAPIKey	Get the series keys from a grouplist

@@ Line 24: / Line 24: @@
 <table class="Gbb1">
 <tr><th>Example</th><th>Description</th></tr>
-<tr><td>func=Version&apikey='''YourAPIKey'''</td><td>Get API Version</td></tr>
+<tr><td>func=RunState&apikey='''YourAPIKey'''</td><td>API Healthcheck</td></tr>
 <tr><td>func=SeriesGet&serieskey='''YourAccount/00004321'''&apikey='''YourAPIKey'''&payloadasjson=true</td><td>Get a Series, return result payload as JSON</td></tr>
 <tr><td>func=SeriesFromGL&glname='''YourGroupName'''&apikey='''YourAPIKey'''</td><td>Get the series keys from a grouplist</td></tr>