Get link
Retrieve a tracked link by its ID.
curl --request GET \
--url https://api.heymarket.com/v1/link/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.heymarket.com/v1/link/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.heymarket.com/v1/link/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.heymarket.com/v1/link/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.heymarket.com/v1/link/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.heymarket.com/v1/link/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heymarket.com/v1/link/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": 42,
"short_code": "AbCd12",
"short_url": "https://r.hey.mk/AbCd12",
"original_url": "https://example.com/promo",
"team_id": 123,
"target": "<string>",
"conversation_id": 123,
"broadcast_id": 123,
"campaign_step_id": 123,
"template_id": 123,
"last_visited_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"code": 400,
"message": "original_url is required",
"details": "<unknown>"
}Unauthorized{
"code": 400,
"message": "original_url is required",
"details": "<unknown>"
}{
"code": 400,
"message": "original_url is required",
"details": "<unknown>"
}too many requests{
"code": 400,
"message": "original_url is required",
"details": "<unknown>"
}errorAuthorizations
Recommended authentication for new integrations. Generate a short-lived JWT from your API Secret ID and API Secret Key, then pass the signed JWT as a bearer token in the Authorization header.
API Secret credentials are available in the Heymarket app under Settings > Integrations > API. The Secret Key is shown only when it is generated, so copy and store it securely before closing the dialog.
Use the following JWT values:
{ "alg": "HS256", "typ": "JWT" }
{ "iss": "YOUR_API_SECRET_ID", "iat": CURRENT_UNIX_TIMESTAMP }
Replace CURRENT_UNIX_TIMESTAMP with the current Unix timestamp in seconds when generating the token.
Sign the JWT with HMAC-SHA256 using this signing secret:
YOUR_API_SECRET_ID||YOUR_API_SECRET_KEY
Send the signed JWT as a bearer token:
Authorization: Bearer YOUR_SIGNED_JWT
Tokens expire 5 minutes after the iat timestamp. Generate a new JWT per request, or cache it briefly for less than 5 minutes. Generate JWTs only from trusted server-side code; do not expose the API Secret Key in browser, mobile, or other client-side code.
Path Parameters
Link ID
Response
The Link
Unique identifier for the link.
42
Code segment of the short URL.
"AbCd12"
Full short URL to include in messages.
"https://r.hey.mk/AbCd12"
Destination URL the short link redirects to.
"https://example.com/promo"
Unique identifier for your team.
Target the link is attributed to.
Conversation the link is attributed to.
Broadcast the link is attributed to.
Campaign step the link is attributed to.
Template the link is attributed to.
Timestamp of the most recent click. Omitted when the link has never been clicked.
Creation date.
Was this page helpful?
curl --request GET \
--url https://api.heymarket.com/v1/link/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.heymarket.com/v1/link/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.heymarket.com/v1/link/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.heymarket.com/v1/link/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.heymarket.com/v1/link/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.heymarket.com/v1/link/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heymarket.com/v1/link/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": 42,
"short_code": "AbCd12",
"short_url": "https://r.hey.mk/AbCd12",
"original_url": "https://example.com/promo",
"team_id": 123,
"target": "<string>",
"conversation_id": 123,
"broadcast_id": 123,
"campaign_step_id": 123,
"template_id": 123,
"last_visited_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"code": 400,
"message": "original_url is required",
"details": "<unknown>"
}Unauthorized{
"code": 400,
"message": "original_url is required",
"details": "<unknown>"
}{
"code": 400,
"message": "original_url is required",
"details": "<unknown>"
}too many requests{
"code": 400,
"message": "original_url is required",
"details": "<unknown>"
}error