OMomnisend
Campaigns

Get campaign UTM settings

Get UTM tag settings for a campaign. The response shape is the same for all campaign types: tags is populated for regular campaigns, variants for A/B campaigns. The absent field is omitted.

Scopes: campaigns.read

Rate Limiting: This endpoint is rate limited to 400 requests per minute.

get/campaigns/{id}/utm

Request

  • Base URL
    https://api.omnisend.com/api
  • URL
    https://api.omnisend.com/api/campaigns/{id}/utm
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://app.omnisend.com/oauth2/token scopes: campaigns.read
    • or API key in header Authorization

Path parameters

idstring required

Campaign ID (24 character hexadecimal)

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Response

UTM settings

Example response

{
  "tags": {
    "campaign": "Welcome Email",
    "medium": "email",
    "source": "omnisend"
  },
  "variants": {
    "a": {
      "id": "000000000000000000000010",
      "tags": {
        "campaign": "Welcome Email",
        "medium": "email",
        "source": "omnisend"
      }
    },
    "b": {
      "id": "000000000000000000000010",
      "tags": {
        "campaign": "Welcome Email",
        "medium": "email",
        "source": "omnisend"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.