Get sheet data in real-time via HTTP
Requires a Business subscription planEach sheet is assigned a unique Live Data URL which you can enable via the Web Application. The Live Data URL allows you to pull data into your system from an Orca Scan sheet using a simple HTTP GET request, for example:
https://api.orcascan.com/sheets/sJ0KYsnp-9b7Rl7i
Works with your favourite tools
Set up a real-time export link to the systems you love without a single line of code.
- Microsoft Excel Automatically send data to Excel spreadsheets
- Google Sheets Automatically send data to Google Sheets
- Microsoft Power BI Transform and visualize your data with Power BI
- Google Data Studio Build dashboards and reports with Data Studio
- Tableau Analyze and understand your data with Tableau
Change format
You can change the format of the data by appending a file extension, for example https://api.orcascan.com/sheets/sJ0KYsnp-9b7Rl7i.json
The available formats are:
| Extension | Format | Content/Type |
|---|---|---|
| .html | HTML (default when no extension provided) | text/html |
| .csv | CSV (Comma-separated values) | text/plain |
| .json | JSON (JavaScript Object Notation) | application/json |
| .xml | XML (Extensible Markup Language) | text/xml |
Include audit trail
You can request all historical changes by appending transactions=true to the URL, for example https://api.orcascan.com/sheets/sJ0KYsnp-9b7Rl7i?transactions=true
An additional row will be added for every change along with three additional columns.
| Changed By | Changed On | Changed Using |
|---|---|---|
| user@email.com | 19/05/2019, 17:25:09 | Chrome 74 (Mac OS) |
| user@email.com | 08/06/2019, 14:19:04 | Thomas's iPhone |
| user@email.com | 07/06/2019, 15:31:07 | Samsung Galaxy S9 |
You can request only the changes after a particular period by providing a date in ISO date format using the from param, for example:
https://api.orcascan.com/sheets/sJ0KYsnp-9b7Rl7i?transactions=true&from=2019-06-12T00:00:00
Include deltas
Appending deltas=true to the Live Data URL along with transactions=true will add an additional column containing the delta for each numerical column change, for example:
https://api.orcascan.com/sheets/sJ0KYsnp-9b7Rl7i?transactions=true&deltas=true
| Barcode | Quantity | Quantity (delta) |
|---|---|---|
| 6344554293308 | 96 | 96 |
| 6344554293308 | 10 | -86 |
| 6344554293308 | 20 | +10 |
By default the first delta value always matches the first numeric value. You can change this to 0 by appending zerodeltabase=true to the URL.
Change date format
By default all dates are returned in ISO 8601 format. You can change the format using the datetimeformat querystring parameter with the desired format. Date formats are a combination of tokens, for example:
https://api.orcascan.com/sheets/sJ0KYsnp-9b7Rl7i?datetimeformat=DD MMM YYYY
The available tokens are:
| Token | Description | Example | |
|---|---|---|---|
| Day | D | Day in single digit format | 2 |
| DD | Day in double digit format | 02 | |
| Month | M | Month in single digit format | 3 |
| MM | Month in double digit format | 03 | |
| MMM | Month in 3 character format | Jan, Feb | |
| MMMM | Full name of month | January, February | |
| Year | YY | 2 digit year | 19 |
| YYYY | 4 digit year | 2019 | |
| Hour | H | 1 digit hour | 3 |
| HH | 2 digit hour | 03 | |
| Minute | m | m digit minute | 3 |
| HH | 2 digit minute | 02 |
Change time zone
Date and times are returned in UTC (timezone 00:00) format. You can adjust the time zone by providing a timezone offset along with datetimeformat parameter, for example:
https://api.orcascan.com/sheets/sJ0KYsnp-9b7Rl7i?DD/MM/YY HH:mm&timezone=-10:00
The available offsets are:
| Offset | Region |
|---|---|
| -12:00 | Eniwetok, Kwajalein |
| -11:00 | Midway Island, Samoa |
| -10:00 | Hawaii |
| -09:30 | Taiohae |
| -09:00 | Alaska |
| -08:00 | Pacific Time (US & Canada) |
| -07:00 | Mountain Time (US & Canada) |
| -06:00 | Central Time (US & Canada), Mexico City |
| -05:00 | Eastern Time (US & Canada), Bogota, Lima |
| -04:30 | Caracas |
| -04:00 | Atlantic Time (Canada), Caracas, La Paz |
| -03:30 | Newfoundland |
| -03:00 | Brazil, Buenos Aires, Georgetown |
| -02:00 | Mid-Atlantic |
| -01:00 | Azores, Cape Verde Islands |
| +01:00 | Brussels, Copenhagen, Madrid, Paris |
| +02:00 | Kaliningrad, South Africa |
| +03:00 | Baghdad, Riyadh, Moscow, St. Petersburg |
| +03:30 | Tehran |
| +04:00 | Abu Dhabi, Muscat, Baku, Tbilisi |
| +04:30 | Kabul |
| +05:00 | Ekaterinburg, Islamabad, Karachi, Tashkent |
| +05:30 | Bombay, Calcutta, Madras, New Delhi |
| +05:45 | Kathmandu, Pokhara |
| +06:00 | Almaty, Dhaka, Colombo |
| +06:30 | Yangon, Mandalay |
| +07:00 | Bangkok, Hanoi, Jakarta |
| +08:00 | Beijing, Perth, Singapore, Hong Kong |
| +08:45 | Eucla |
| +09:00 | Tokyo, Seoul, Osaka, Sapporo, Yakutsk |
| +09:30 | Adelaide, Darwin |
| +10:00 | Eastern Australia, Guam, Vladivostok |
| +10:30 | Lord Howe Island |
| +11:00 | Magadan, Solomon Islands, New Caledonia |
| +11:30 | Norfolk Island |
| +12:00 | Auckland, Wellington, Fiji, Kamchatka |
| +12:45 | Chatham Islands |
| +13:00 | Apia, Nukualofa |
| +14:00 | Line Islands, Tokelau |
Force download
By default data is returned inline so it can be displayed in a browser. However, some Data Warehousing / ETL tools require data imported from a URL to trigger a download.
You can enable this behaviour by appending download=true to the URL. For example https://api.orcascan.com/sheets/sJ0KYsnp-9b7Rl7i.xml?download=true
Get Live Data Url
You can find the data URL on any of your sheets.
1. Go to Integrations settings
2. Activate the URL and copy the link
3. Save the updates
Next steps
Questions about the Live Data URL?
We're happy to help you troubleshoot any issues, chat with us live or drop us an email.