Create campaign
curl --request POST \
--url https://app.keupera.com/api/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"website_id": "b3f1...",
"keyword": "seo tools",
"niche": "Digital Marketing",
"language": "en",
"target_domain": "myblog.com"
}
'import requests
url = "https://app.keupera.com/api/v1/campaigns"
payload = {
"website_id": "b3f1...",
"keyword": "seo tools",
"niche": "Digital Marketing",
"language": "en",
"target_domain": "myblog.com"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
website_id: 'b3f1...',
keyword: 'seo tools',
niche: 'Digital Marketing',
language: 'en',
target_domain: 'myblog.com'
})
};
fetch('https://app.keupera.com/api/v1/campaigns', 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://app.keupera.com/api/v1/campaigns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'website_id' => 'b3f1...',
'keyword' => 'seo tools',
'niche' => 'Digital Marketing',
'language' => 'en',
'target_domain' => 'myblog.com'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.keupera.com/api/v1/campaigns"
payload := strings.NewReader("{\n \"website_id\": \"b3f1...\",\n \"keyword\": \"seo tools\",\n \"niche\": \"Digital Marketing\",\n \"language\": \"en\",\n \"target_domain\": \"myblog.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.keupera.com/api/v1/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"website_id\": \"b3f1...\",\n \"keyword\": \"seo tools\",\n \"niche\": \"Digital Marketing\",\n \"language\": \"en\",\n \"target_domain\": \"myblog.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.keupera.com/api/v1/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"website_id\": \"b3f1...\",\n \"keyword\": \"seo tools\",\n \"niche\": \"Digital Marketing\",\n \"language\": \"en\",\n \"target_domain\": \"myblog.com\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"keyword": "seo tools",
"niche": "Digital Marketing",
"status": "active",
"language": "en",
"target_domain": "example.com",
"is_public": true,
"public_share_token": "<string>",
"progress": {},
"general_strategies": [
{}
],
"websites": {
"url": "<string>"
},
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": "Missing required field: keywords"
}{
"error": "Invalid or missing API key"
}{
"error": "Usage limit reached for keyword_research"
}Backlinks
Create campaign
Creates a backlink research campaign. Opportunity research is triggered automatically in the background once the campaign is created. Consumes backlink research credits.
POST
/
campaigns
Create campaign
curl --request POST \
--url https://app.keupera.com/api/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"website_id": "b3f1...",
"keyword": "seo tools",
"niche": "Digital Marketing",
"language": "en",
"target_domain": "myblog.com"
}
'import requests
url = "https://app.keupera.com/api/v1/campaigns"
payload = {
"website_id": "b3f1...",
"keyword": "seo tools",
"niche": "Digital Marketing",
"language": "en",
"target_domain": "myblog.com"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
website_id: 'b3f1...',
keyword: 'seo tools',
niche: 'Digital Marketing',
language: 'en',
target_domain: 'myblog.com'
})
};
fetch('https://app.keupera.com/api/v1/campaigns', 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://app.keupera.com/api/v1/campaigns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'website_id' => 'b3f1...',
'keyword' => 'seo tools',
'niche' => 'Digital Marketing',
'language' => 'en',
'target_domain' => 'myblog.com'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.keupera.com/api/v1/campaigns"
payload := strings.NewReader("{\n \"website_id\": \"b3f1...\",\n \"keyword\": \"seo tools\",\n \"niche\": \"Digital Marketing\",\n \"language\": \"en\",\n \"target_domain\": \"myblog.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.keupera.com/api/v1/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"website_id\": \"b3f1...\",\n \"keyword\": \"seo tools\",\n \"niche\": \"Digital Marketing\",\n \"language\": \"en\",\n \"target_domain\": \"myblog.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.keupera.com/api/v1/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"website_id\": \"b3f1...\",\n \"keyword\": \"seo tools\",\n \"niche\": \"Digital Marketing\",\n \"language\": \"en\",\n \"target_domain\": \"myblog.com\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"keyword": "seo tools",
"niche": "Digital Marketing",
"status": "active",
"language": "en",
"target_domain": "example.com",
"is_public": true,
"public_share_token": "<string>",
"progress": {},
"general_strategies": [
{}
],
"websites": {
"url": "<string>"
},
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": "Missing required field: keywords"
}{
"error": "Invalid or missing API key"
}{
"error": "Usage limit reached for keyword_research"
}Authorizations
Pass your Keupera API key as a Bearer token: Authorization: Bearer YOUR_KEUPERA_API_KEY. Generate keys from Account → API Keys in your Keupera dashboard.
Body
application/json
Target keyword for backlink research.
Industry / niche context.
Language code. Defaults to the website language.
Domain to research backlinks for. Defaults to the website's own domain. Useful for a subdomain or partner site.
Response
Campaign created.
Show child attributes
Show child attributes
⌘I