ToolsShort Links

Get short link status

Returns whether the short link is still active, when it was created, when it expires and how many clicks it has accumulated. Only the user of the App-Key that created the link can query it.

Authentication

x-api-keystring

App-Key of the account. Any channel is accepted.

OR
AuthorizationBearer

OAuth 2.0 access token issued by POST /api/oauth/token. Takes precedence over x-api-key when both are sent.

Path parameters

codestringRequired=10 characters

The 10-character identifier returned when the link was created.

Response

Short link status.
codestringOptional
The identifier that was queried.
urlstringOptional
Destination URL.
activebooleanOptional

true while the link is within its 3-day TTL.

total_clicksintegerOptional
Accumulated opens of the short link.
created_atdatetimeOptional
expires_atdatetimeOptional

Informational; created_at + 3 days.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error