Skip to navigation
API Reference

Get details on a mapping

Path parameters

domainenumRequiredDefaults to m
The domain name of the URL.
Allowed values:
guidstringRequired
The URL path.

Response

Success response.
longUrlstring
The URL that the user should be redirected to. Must be a valid URL.
shortUrlstring

The returned shortUrl will only be "short" in E3, where the m, go, bca.m, t.m DNS records are in place. In E1, the value will begin with empurlshortener-dev.americanexpress.com. In E2, the value will begin with empurlshortener-qa.americanexpress.com.

expDatestring

The date that the shortUrl will expire on. Expired URLs will redirect users to the URL not found page. We generally recommend you pick a expiration date that is twice as long as you expect the URL to be 'useful' for. See these examples. If you are generating one-off links (OTP, safe key, user specific American Express offer, etc.) which will be used in the next three days, then pick a expiration date of one week. Alternatively if you are generating links for a marketing campaign where the campaign is expected to finish one year from now, then give an expiration date of two years.

paramsobjectOptional
This is to provide additional metadata about the URL. It also can be used to set advanced options for the URL, like cache strategy or retention period.

Errors

400
Bad Request Error