POST web

utm_parse

1 credit

Extract UTM campaign parameters from a URL

Endpoint

POST /api/v1/tools/web/utm_parse

Body Parameters

url string required

Example

input Request

{
    "url": "https://example.com/?utm_source=google&utm_medium=cpc&utm_campaign=spring"
}

output Response

{
    "term": "",
    "medium": "cpc",
    "source": "google",
    "content": "",
    "campaign": "spring",
    "has_required": true
}

Response Format

HTTP/1.1 200 OK SUCCESS

{
  "success": true,
  "data": {
    "term": "",
    "medium": "cpc",
    "source": "google",
    "content": "",
    "campaign": "spring",
    "has_required": true
},
  "meta": {
    "tool": "utm_parse",
    "credits_consumed": 1
  }
}

HTTP/1.1 422 Unprocessable Entity ERROR

{
  "success": false,
  "data": null,
  "error": {
    "code": "validation_error",
    "message": "The given data was invalid."
  }
}

Code Examples

Request Example

lightbulb Developer Tip

Credits are deducted before execution. If the upstream tool fails, credits are automatically refunded to your account.