Retrieve a campaign
curl --request GET \
--url https://api.dashlink.ai/api/v1/campaigns/get_campaign_details \
--header 'X-API-Key: <api-key>'const url = 'https://api.dashlink.ai/api/v1/campaigns/get_campaign_details';
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://api.dashlink.ai/api/v1/campaigns/get_campaign_details"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.dashlink.ai/api/v1/campaigns/get_campaign_details"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.dashlink.ai/api/v1/campaigns/get_campaign_details")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dashlink.ai/api/v1/campaigns/get_campaign_details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {}
}{
"error": {
"message": "Invalid sort_by option. Choose from name, most_recent, last_modified",
"status_code": 400,
"code": "INVALID_PARAMETER",
"details": {
"parameter": "sort_by",
"value": "most_clicked",
"valid_options": [
"name",
"most_recent",
"last_modified"
]
}
}
}{
"error": {
"message": "Authentication required. Please provide valid credentials.",
"status_code": 401,
"code": "AUTHENTICATION_REQUIRED"
}
}{
"error": {
"message": "You do not have permission to perform this action.",
"status_code": 403,
"code": "PERMISSION_DENIED"
}
}{
"error": {
"message": "Shortlink not found.",
"status_code": 404,
"code": "NOT_FOUND"
}
}{
"error": {
"message": "Rate limit exceeded. Please retry in 43 seconds.",
"status_code": 429,
"code": "RATE_LIMIT_EXCEEDED"
}
}{
"error": {
"message": "An unexpected error occurred. Please try again.",
"status_code": 500,
"code": "INTERNAL_SERVER_ERROR"
}
}Campaigns
Retrieve a campaign
Get details of the campaign, including its channels, shortlinks, total click data at channel level, total number of channels, and total number of links across all channels. Supports both session-based auth and API key auth.
GET
/
api
/
v1
/
campaigns
/
get_campaign_details
Retrieve a campaign
curl --request GET \
--url https://api.dashlink.ai/api/v1/campaigns/get_campaign_details \
--header 'X-API-Key: <api-key>'const url = 'https://api.dashlink.ai/api/v1/campaigns/get_campaign_details';
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://api.dashlink.ai/api/v1/campaigns/get_campaign_details"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.dashlink.ai/api/v1/campaigns/get_campaign_details"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.dashlink.ai/api/v1/campaigns/get_campaign_details")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dashlink.ai/api/v1/campaigns/get_campaign_details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {}
}{
"error": {
"message": "Invalid sort_by option. Choose from name, most_recent, last_modified",
"status_code": 400,
"code": "INVALID_PARAMETER",
"details": {
"parameter": "sort_by",
"value": "most_clicked",
"valid_options": [
"name",
"most_recent",
"last_modified"
]
}
}
}{
"error": {
"message": "Authentication required. Please provide valid credentials.",
"status_code": 401,
"code": "AUTHENTICATION_REQUIRED"
}
}{
"error": {
"message": "You do not have permission to perform this action.",
"status_code": 403,
"code": "PERMISSION_DENIED"
}
}{
"error": {
"message": "Shortlink not found.",
"status_code": 404,
"code": "NOT_FOUND"
}
}{
"error": {
"message": "Rate limit exceeded. Please retry in 43 seconds.",
"status_code": 429,
"code": "RATE_LIMIT_EXCEEDED"
}
}{
"error": {
"message": "An unexpected error occurred. Please try again.",
"status_code": 500,
"code": "INTERNAL_SERVER_ERROR"
}
}