¶ Description
Get Data from Supermetrics.
¶ Parameters
¶ Parameters tab
Parameters:
- Developer mode: activate/deactivate code tab.
- Short url The Supermetrics short link that returns JSON.
- Debug information level Log verbosity.
- Optional: extra parameters for cURL Add HTTP headers, proxy, timeouts, retries. Needed for Bearer/OAuth.
- Number of retries on connection error Network retry count for the action.
¶ Description tab
See dedicated page for more information.
¶ Code tab
supermetricsRawDownload is a scripted action. Embedded code is accessible and customizable through this tab.
¶ Configuration tab
See dedicated page for more information.
¶ About
Downloads raw JSON from a Supermetrics Enterprise Short URL (aka “s/…/json” endpoint). You can then parse the JSON into a table and continue your pipeline.
¶ Prerequisites
-
A working Supermetrics Enterprise environment.
-
A Short URL for your query (created in Supermetrics Query Manager).
-
One of these auth setups:
- API key in the URL (easiest), or
- Bearer/OAuth token passed as a header (via the
Optional: extra parameters for cURLcURL field below).
¶ Step-by-step (Quick Start)
-
Create / copy the Short URL
- In Supermetrics Query Manager, build your query (source, metrics, dimensions, date range, filters).
- Click Create API / Short link (or similar) and copy the JSON URL:
https://api.supermetrics.com/enterprise/query/s/<SHORT_ID>/json - (Optional) Add parameters like
start_date,end_date, etc. to the URL. Remember to URL-encode if needed.
-
Open the
supermetricsRawDownloadnode- Paste the Short URL into Short url.
- Set Debug information level to basic while testing.
-
Provide authentication
- If your tenant uses an API key in the URL: nothing else to do; keep the key in the URL query string.
- If your tenant uses OAuth/Bearer: add the header(s) in Optional: extra parameters for cURL, e.g.:
-H "Authorization: Bearer ya29.a0AfH6..." -H "Accept: application/json"
-
(Optional) Harden the call
- In Optional: extra parameters for cURL, you can also add:
--connect-timeout 60 --retry 3 --retry-delay 2 - Adjust Number of retries on connection error if you want the action itself to retry network errors.
- In Optional: extra parameters for cURL, you can also add:
-
Run
- Click Run.
- Inspect Process → Records to see the raw JSON response.
-
Parse JSON to a table (next node)
-
Add your JSON parsing node (e.g., JSON → Table / JSONParse).
-
Typical paths (verify with your payload):
- Columns:
data.columns[*].idordata.columns[*].name - Rows:
data.rows
- Columns:
-
Continue with your transforms (rename columns, types) and output (CSV, DB, etc.).
-
¶ Examples
¶ A. API key in URL (no headers required)
- Short url
https://api.supermetrics.com/enterprise/query/s/abc123/json?api_key=SMT-XXXX&start_date=2025-08-01&end_date=2025-08-12 - Optional: extra parameters for cURL
--connect-timeout 60 --retry 3 --retry-delay 2
¶ B. OAuth/Bearer token
- Short url
https://api.supermetrics.com/enterprise/query/s/abc123/json?start_date=last_30_days - Optional: extra parameters for cURL
-H "Authorization: Bearer ya29.a0AfH6..." -H "Accept: application/json" --connect-timeout 60 --retry 3 --retry-delay 2
¶ Output shape (typical)
Supermetrics JSON commonly looks like this (simplified):
{
"data": {
"columns": [
{"id": "date", "name": "Date"},
{"id": "sessions", "name": "Sessions"}
],
"rows": [
["2025-08-01", 123],
["2025-08-02", 145]
]
},
"meta": { ... }
}
Use your JSON node to map:
- Headers →
data.columns[*].id(or.name) - Rows →
data.rows
¶ Troubleshooting
-
401 Unauthorized / “unauthorized_client”
- API key missing/invalid → ensure it’s present in the URL and not expired.
- Bearer token required → set the
Authorizationheader in Optional: extra parameters for cURL. - Token expired → refresh and paste the new token.
-
403 Forbidden
- The short link or source isn’t accessible to your account. Check Supermetrics permissions/sharing.
-
400 Bad Request
- Malformed URL or parameters. Verify it ends with
/jsonand that query params are URL-encoded.
- Malformed URL or parameters. Verify it ends with
-
Timeouts/large queries
- Increase timeouts & retries in Optional: extra parameters for cURL:
--connect-timeout 120 --retry 5 --retry-delay 3 - Narrow date range or page the query if your tenant supports it.
- Increase timeouts & retries in Optional: extra parameters for cURL:
-
Behind a proxy
- Add to Optional: extra parameters for cURL:
-x http://USER:PASS@HOST:PORT
- Add to Optional: extra parameters for cURL:
¶ Security notes
- Treat short URLs, API keys, and tokens as secrets.
- Prefer passing Bearer tokens via the header (
Optional: extra parameters for cURL) instead of embedding in URLs when possible. - Rotate tokens/keys regularly.
You’re set. Paste your short URL, add auth (if needed), run, and then parse the JSON into a table.
