Skip to main content

Squillify development is paused indefinitely. Read why, and discover what this experiment achieved. Read the story

MicroSkills Reference

Campaign URL Reader

marketing.utm_parse

ProductionBounded custom (Class B)Deterministicstrictinstantv1.0.0
No network

Overview

You send a link and we tell you which campaign parameters it carries, what their values decode to, how often each one repeats and which vocabulary each belongs to — the five core parameters, Google's four additions, or one of fourteen vendor click identifiers. The cleaned link comes back beside them, with exactly those parameters removed and nothing else touched: host case, port, dot segments, the order and bytes of every surviving parameter, and the fragment all survive. Repeated parameters are reported rather than resolved, because which one an analytics product honours is its decision and not ours. We fetch nothing and canonicalise nothing.

Link normalisers drop tracking parameters and tell you only the names they dropped, which is the wrong half: you wanted to know that the visitor came from the spring newsletter, not that a parameter called utm_campaign used to be there. You get the values, the repetition and the cleaned link in one answer.

Reliability

Fully deterministic: the same link and options give you the same answer, on any machine, under any locale or time zone. Failures, and what to do about each: UTM_PARSE_URL_INVALID means the link is not a well-formed absolute URL with a host, or carries a space, a control character or surrounding whitespace, so clean it up and send it again; UTM_PARSE_URL_NOT_ABSOLUTE means there is no scheme, and we resolve nothing against a base, so send the full link; UTM_PARSE_URL_SCHEME_UNSUPPORTED means the scheme is neither http nor https, and campaign tagging does not apply to other schemes; UTM_PARSE_URL_USERINFO_FORBIDDEN means the authority carries credentials, which we refuse rather than copy into a cleaned link you then store; UTM_PARSE_URL_TOO_LARGE means the link is past 8192 code points, so shorten it or read the query yourself; UTM_PARSE_QUERY_LIMIT_EXCEEDED means the link carries more than 500 query parameters, which is well past anything a browser will keep, so trim it; UTM_PARSE_PARAM_NAME_TOO_LONG means a parameter name runs past 64 code points, and the index of the offending pair is in the details; UTM_PARSE_PARAM_VALUE_TOO_LONG means a raw value runs past 1024 code points, and again the details carry the index rather than the value; UTM_PARSE_ESCAPE_MALFORMED means a percent escape is broken or the bytes are not valid text, so either fix the link or send PRESERVE_LITERAL to keep the sequence verbatim; UTM_PARSE_CLASS_UNSUPPORTED means include held something other than one to three of the listed class names, so correct the list; UTM_PARSE_POLICY_UNSUPPORTED means spaceDecoding, repeatedKeyPolicy, malformedEscapePolicy or unicodeForm is not one of its listed members, and we never quietly fall back to a default. None of these is worth retrying unchanged.

Context footprint

Returns one small entry per campaign parameter plus the cleaned link. Parameters outside the vocabulary come back as a count, not as text. A successful call costs 1 execution credit.

When to use it

When you need the campaign values off a link, or a copy of the link with exactly those parameters removed and nothing else changed.

When you want a canonical link for comparison, or you want parameters outside the campaign vocabulary reported.

Scope

Note
Report the campaign parameters an http or https link carries, with their decoded values and repetition, and return the link without them.

Non-goals

  • Does not canonicalise the link — the cleaned link is not a comparison key, and web.normalize_url is what produces one
  • Does not fetch, resolve, expand or check the link
  • Does not decide which repeated occurrence wins; every one is reported
  • Does not report a name it cannot classify, so there is no utm_ prefix rule
  • Does not report routing or cookie-linker parameters such as ref, _ga and _gl

Properties

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

data-transformationparsing

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call1 credit

File handling

Accepts file_refProduces file_refMax input64 KB

How we handle your data

Sensitive output possible
What this means

This skill may receive sensitive content and may return submitted, transformed, extracted, or reformatted content.

Squillify guarantees
  • Runs inside Squillify
  • This skill runs inside Squillify.
  • Payloads are not sent to an external service by this skill.
  • Squillify does not permanently store submitted payloads.
  • Telemetry records metadata only, not submitted content.
  • Submitted payloads are not used for training.
  • Submitted payloads are not reviewed by humans.
  • This skill does not target sensitive data.
  • The response may contain submitted or transformed content.
Your responsibility

Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.

Read the Microskill Data Handling Policy

Input schema

FieldTypeRequiredDescription
urlstringYesAbsolute http or https link to read, up to 8192 code points, with a host and no credentials.
includearrayNoOne to three of UTM_CORE, UTM_EXTENDED, and CLICK_IDS; omit it to report all three classes.
spaceDecodingstringNoHow plus signs in values are decoded; omit it for PLUS_AS_SPACE.
repeatedKeyPolicystringNoWhich repeated values byName keeps; omit it for ALL. The params list always carries every occurrence.
malformedEscapePolicystringNoWhat to do with a broken percent escape; omit it for FAIL.
unicodeFormstringNoUnicode normalisation applied to decoded values only; omit it for NONE.

Output schema

FieldTypeRequiredDescription
paramsarrayYesOne entry per campaign parameter occurrence in query order, including repeats.
byNameobjectYesPurpose-bound map from campaign parameter name to decoded value arrays, narrowed by repeatedKeyPolicy; a bare name maps to an empty list.
cleanUrlstringYesSubmitted link with every reported occurrence removed and nothing else changed.
summaryobjectYesClosed parse counters for matched names, removed occurrences, repeats, other query params, malformed escapes, decoding settings, classes looked for, and truncation.

API contract

POST /v1/execute
curl
curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"marketing.utm_parse","input":{"url":"https://acme.example.com/pricing?utm_source=newsletter&utm_medium=email"}}'
Integrations
TypeScript SDK
import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("marketing.utm_parse", {"url":"https://Example.com/pricing?plan=team&utm_source=news+letter#faq"});

Errors

CodeHTTPRetryableDescription
VALIDATION_ERROR400NoThe request payload failed schema validation.
UNAUTHORIZED401NoMissing or invalid API key.
SKILL_NOT_ACCESSIBLE403NoThe API key is not granted access to this skill.
SKILL_NOT_AVAILABLE_FOR_PLAN403NoThis skill is not included in your current plan.
PLAN_ELIGIBILITY_UNAVAILABLE503YesPlan eligibility could not be decided. Retry after backoff.
SKILL_NOT_FOUND404NoThe requested skill or version does not exist.
TENANT_RATE_LIMITED429YesRequest rate limit exceeded. Retry after backoff.
QUOTA_EXCEEDED429YesPlan quota exhausted. Retryable once the quota period resets.
EXECUTION_TIMEOUT504YesExecution exceeded the allowed time budget.
UTM_PARSE_URL_INVALID400NoThe request payload failed this skill's input validation.
UTM_PARSE_URL_NOT_ABSOLUTE400NoThe request payload failed this skill's input validation.
UTM_PARSE_URL_SCHEME_UNSUPPORTED400NoThe skill does not support the requested variant.
UTM_PARSE_URL_USERINFO_FORBIDDEN422NoThe input was rejected as unsafe.
UTM_PARSE_URL_TOO_LARGE429NoA size, quota, rate, or time limit was exceeded.
UTM_PARSE_QUERY_LIMIT_EXCEEDED429NoA size, quota, rate, or time limit was exceeded.
UTM_PARSE_PARAM_NAME_TOO_LONG429NoA size, quota, rate, or time limit was exceeded.
UTM_PARSE_PARAM_VALUE_TOO_LONG429NoA size, quota, rate, or time limit was exceeded.
UTM_PARSE_ESCAPE_MALFORMED400NoThe request payload failed this skill's input validation.
UTM_PARSE_CLASS_UNSUPPORTED400NoThe skill does not support the requested variant.
UTM_PARSE_POLICY_UNSUPPORTED400NoThe skill does not support the requested variant.

Other limits

LimitValue
Recommended inline bytes32 KiB

Limitations

  • Does not canonicalise the link — the cleaned link is not a comparison key, and web.normalize_url is what produces one
  • Does not fetch, resolve, expand or check the link
  • Does not decide which repeated occurrence wins; every one is reported
  • Does not report a name it cannot classify, so there is no utm_ prefix rule
  • Does not report routing or cookie-linker parameters such as ref, _ga and _gl
  • Producing a canonical link to compare or deduplicate against
  • Reading parameters that are not campaign parameters
  • Checking whether the link resolves or what it returns

How to call

POST /v1/execute (requires authentication)

Request bodyjson
{
  "skillKey": "marketing.utm_parse",
  "input": {
    "url": "https://Example.com/pricing?plan=team&utm_source=news+letter#faq"
  }
}

Examples

Recover the campaign that brought a visitor

Inputjson
{
  "url": "https://Example.com/pricing?plan=team&utm_source=news+letter#faq"
}
Expected outputjson
{
  "params": [
    {
      "name": "utm_source",
      "class": "utm_core",
      "occurrence": 0,
      "valuePresent": true,
      "value": "news letter",
      "rawValue": "news+letter"
    }
  ],
  "cleanUrl": "https://Example.com/pricing?plan=team#faq",
  "summary": {
    "matchedCount": 1,
    "removedOccurrenceCount": 1,
    "repeatedNames": [],
    "otherQueryParamCount": 1,
    "malformedEscapeCount": 0,
    "spaceDecoding": "plus_as_space",
    "unicodeForm": "none",
    "classes": [
      "utm_core",
      "utm_extended",
      "click_ids"
    ],
    "truncated": false
  },
  "byName": {
    "utm_source": [
      "news letter"
    ]
  }
}
Tip
The plus sign decodes to a space under the default, the host keeps its capital E, and the fragment survives.

Strip click identifiers only, leaving campaign parameters in place

Inputjson
{
  "url": "https://acme.example.com/offer?utm_source=newsletter&gclid=EAIaIQobChMI",
  "include": [
    "CLICK_IDS"
  ]
}
Expected outputjson
{
  "params": [
    {
      "name": "gclid",
      "class": "click_ids",
      "occurrence": 0,
      "valuePresent": true,
      "value": "EAIaIQobChMI",
      "rawValue": "EAIaIQobChMI"
    }
  ],
  "cleanUrl": "https://acme.example.com/offer?utm_source=newsletter",
  "summary": {
    "matchedCount": 1,
    "removedOccurrenceCount": 1,
    "repeatedNames": [],
    "otherQueryParamCount": 1,
    "malformedEscapeCount": 0,
    "spaceDecoding": "plus_as_space",
    "unicodeForm": "none",
    "classes": [
      "click_ids"
    ],
    "truncated": false
  },
  "byName": {
    "gclid": [
      "EAIaIQobChMI"
    ]
  }
}
Tip
A class you leave out of include is neither reported nor removed, so utm_source stays in the cleaned link.
  • Recover which campaign brought a visitor, by value and not just by name
  • Strip campaign parameters before storing a link as content, keeping the rest of the query byte for byte
  • Reconcile a click identifier against a vendor report, using the raw and decoded forms side by side

Avoid for

  • Producing a canonical link to compare or deduplicate against
  • Reading parameters that are not campaign parameters
  • Checking whether the link resolves or what it returns

Composable with

Safety & privacy

  • Runs without calling any external service.
  • Your payloads are never stored permanently.
  • Telemetry captures metadata only — never your payload contents.
  • We never train models on your payloads.
  • No human reviews your payloads.

Tags

marketingurlparsingcampaign