DeepLink - Sharing Data Using Sharelinks

A Sharelink is a URL that shares the data of a saved report. With Sharelinks, you can view report data without signing in to the Airbridge dashboard and import it into Google Sheets to use with your internal data. This guide explains how to create a Sharelink, use parameters to change its settings such as the date range or language, and import its data into Google Sheets with Google Apps Script or the IMPORTDATA function.

​

Creating Sharelinks

You need to have a saved Actuals Report to create a Sharelink. If you don’t have a saved Actuals Report, save a report view first.

1. Click Saved Reports at the top right to open the report you want to share from the drop-down list. Or, if you want to create a Sharelink of the report you have just created, click Save at the top right.

2. Click the [share] icon on the top right.

3. Switch on the [Create Sharelink] toggle. A Sharelink will appear below the toggle.

4. Click the Sharelink below the toggle to copy it. Share the Sharelink with anyone you want to share your report data. Note that if the toggle is turned off, the Sharelink won’t work anymore. Every time you switch on the toggle, a new Sharelink is created, and the new link must be shared.

​

Customizing Sharelinks

The Sharelink can be customized by adding new parameters or editing the existing parameters to modify the settings in the data. The structure of a Sharelink looks like the following.

• Sharelink structure: Basic URL?parameter1&parameter2&parameter3
• Basic URL: report.airbridge.io/v3/(URL).csv

The data in the downloaded CSV file has the same date range, metrics, GroupBy, filter, language settings as the original report. The CSV file downloaded from a Sharelink can carry up to 1,000 rows by default. By adding parameters or editing the existing parameters, the Sharelink can be customized to modify the settings in the data, such as the language settings, date range, number of rows, etc. A question mark (”?”) must be present at the end of the URL before the parameters. For example, by adding the rowNo parameter to the Sharelink, up to 50,000 rows can be downloaded. The following table lists the parameters that are available.

Parameters available for Sharelink customization

A Sharelink can have only 1 of the 3 parameters that are related to date range settings (from, since, last). Those parameters can be configured for up to 400 days.By configuring the rowNo parameter, up to 50,000 rows of data can be downloaded as a CSV file from the Sharelink.The table below lists the parameters available for customizing Sharelinks of Actuals Reports.

Parameter	Description	Format	Example
from, to	Sets a specific date range	YYYY-MM-DD	from=2022-01-01&to=2022-03-01
since	Sets the date range from a specific date to today	YYYY-MM-DD	since=2022-01-01
last	- Sets the date range to the last n days. - The date range does not include today unless n=0.	0 or natural numbers (1, 2, 3…)	last=3
offset	- Changes the last date of the date range from today to n days before today. - This must be used together with date range parameters.	Natural numbers (1, 2, 3…)	offset=3
rowNo	- Provides data in n rows. - Can be configured to max. 50,000 rows.	Natural numbers (1~50,000)	rowNo=5000
granularity	- Changes the date unit of last and offset parameters to day, week, or month. - If not specified, the date unit is “day”	day/week/month	granularity=day
language	- Changes the language settings of the Sharelink. - If not specified, the same language as the Airbridge dashboard is applied.	en/ko	language=en
useCache	- If set to false, returns newly queried report data instead of report data queried within the last 3 hours. - Works only with /v3/ Sharelinks. - If this parameter is not used, true is applied.	false	useCache=false
isNowEnabled	- Used with the last parameter. - If this parameter is not used, false is applied. (true: includes today, false:does not include today)	true/false	isNowEnabled=false

When adding multiple parameters, separate them with an ampersand (”&”).

​

Sharelink parameter examples

A Sharelink starts with report.airbridge.io/v3/(URL).csv followed by a question mark and addtional parameters. See the following examples to understand how to customize Sharelinks.

​

Using Sharelinks in Google Sheets

There are two ways to import Sharelink data into Google Sheets, as shown in the following table. To refresh the data every day during the hour you set, use Google Apps Script. If a refresh interval set by Google works for you, use the IMPORTDATA function. You can use Sharelinks and Google Sheets for the following:

• Importing Airbridge data into Google Sheets automatically
• Sharing Airbridge data externally, regardless of access permissions
• Creating a custom report by integrating Airbridge data with internal company data

If the same report was queried in the Airbridge dashboard or through a Sharelink within the last 3 hours, the Sharelink returns the report data from that query instead of starting a new one. Otherwise, the Sharelink starts a new query. To start a new query instead of using report data queried within the last 3 hours, add useCache=false to the end of the Sharelink URL. If the URL already contains a question mark (?), add &useCache=false. Otherwise, add ?useCache=false. useCache=false works only with /v3/ URLs.

​

Import data with Google Apps Script

Google Apps Script imports data during the hour you set, whether or not the spreadsheet is open. Add and run the sample script as follows:

1. In Google Sheets, go to [Extensions]>[Apps Script]. Paste the sample script, enter your Sharelink URL, and save the script.
2. Return to the spreadsheet and reload the page. When [Sharelink] appears to the right of [Help], select [Sharelink]>[Refresh now].
3. In the [Authorization required] window, click OK. On the Google permission screen that follows, select the Select all checkbox, and then click Continue. You only need to authorize the script once.
4. To refresh the data automatically every day during the hour you set, select [Sharelink]>[Turn on daily refresh at 9:00]. To change the time, set DAILY_HOUR in the sample script to a number from 0 to 23 (24-hour clock), save the script, reload the spreadsheet, and then select [Sharelink]>[Turn on daily refresh at N:00] again.

For the sample script and screen-by-screen instructions, see Import Sharelink Data With Google Apps Script.

​

Import data with the IMPORTDATA function

To view Sharelink data in Google Sheets, enter the Sharelink in the IMPORTDATA function as shown below.

• =IMPORTDATA("Full Sharelink")

The IMPORTDATA function calls the Sharelink again at an interval set by Google’s policy. The interval cannot be changed in Airbridge. To import data during the hour you set, use Google Apps Script. If the same report wasn’t queried in the Airbridge dashboard or through a Sharelink within the last 3 hours, the Sharelink starts a new query, and a notice that starts with “We couldn’t load Sharelink data yet” appears instead of data. The notice means the query is in progress, not that it failed. After the query finishes, reload the spreadsheet to see the new report data.