Developer Marketing1.0.0-beta.1

Preview a Marketing UTM URL

Applies the Space’s saved naming rules and preserves unrelated query parameters and the URL fragment. No link is saved and the destination is never fetched.

POST/api/v1/marketing/utm/preview

Workspace automation for approved Dashio products. Each token is scoped to one Space and independently granted operations. Requests spend shared minute credits, and selected operation groups also share hourly quotas.

Required token scope is marketing:utm:preview. Scopes are independent.

This operation uses 1 credit from a shared budget of 60 credits per token and 300 per Space each UTC minute.

Run these examples on a trusted server with DASHIO_API_TOKEN configured. Use a private terminal when inspecting response data. Examples send one request with a bounded timeout and do not retry automatically.

Authentication

Dashio developer token (HTTP Bearer) API authentication guide

Path parameters

None documented.

Query parameters

None documented.

Header parameters

None documented.

Request body

application/json · Required

JSON up to 8 KiB. Supply the original destination and UTM parameters.

destinationUrlstring (uri)Required: Absolute HTTP or HTTPS URL without embedded credentials. Maximum length: 2048.
parametersobjectRequired: No field description supplied.

Request & response examples

Copy an example in your preferred language.

request.sh

: "${DASHIO_API_TOKEN:?Set DASHIO_API_TOKEN before running this example}"

curl --fail-with-body --include --silent --show-error --connect-timeout 10 --max-time 30 \
  --request POST 'https://app.dashio.net/api/v1/marketing/utm/preview' \
  --header "Authorization: Bearer $DASHIO_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  "destinationUrl": "https://example.com/product?ref=launch#details",
  "parameters": {
    "source": "Newsletter",
    "medium": "Email",
    "campaign": "Spring Launch",
    "term": "",
    "content": ""
  }
}'

Replace URL parameters, credentials, and schema placeholders before running. No request is sent by this page.

Schema-generated example; not a captured response.

{
  "url": "https://example.com/",
  "appliedParameters": {
    "source": "<source>",
    "medium": "<medium>",
    "campaign": "<campaign>",
    "term": "<term>",
    "content": "<content>"
  },
  "overriddenKeys": [
    "source"
  ]
}

Run examples on a trusted server. Configure the environment variables and replace URL or schema placeholders. For a write, reuse its saved idempotency key only when retrying the identical request.

Responses

Headers on every response

X-Request-Idstring (uuid)Optional: Server-generated ID to include in a support request.

200

Generated URL, applied values and names of overwritten UTM parameters.

Response headers

RateLimit-LimitintegerOptional: Per-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.
RateLimit-RemainingintegerOptional: Requests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.
RateLimit-ResetintegerOptional: Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

application/json

urlstring (uri)Required: Maximum length: 2048.
appliedParametersobjectRequired: No field description supplied.
overriddenKeysarray of stringRequired: Maximum items: 5.

400

Invalid URL, query, parameters, or resulting URL length.

application/json

statusCodeintegerRequired: Minimum: 400. Maximum: 599.
statusMessagestringOptional: A safe explanation suitable for display.
dataobjectRequired: No field description supplied.

401

Developer token is missing or invalid.