Pool
curl --request GET \
--url https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid} \
--header 'X-API-Key: <api-key>'import requests
url = "https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}', 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://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}",
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;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}"
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))
}HttpResponse<String> response = Unirest.get("https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}")
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{
"success": true,
"data": {
"pool_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Summer promo",
"status": "active",
"formats": [
"story"
],
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"rotation_type": "equal",
"daily_limits": {
"story": 2,
"mass_dm": 1
},
"same_target_cooldown_days": 123,
"friends_ttl_days": 123,
"bio_ttl_days": 123,
"post_ttl_days": 123,
"publish_settings": {
"pin_posts": true,
"post_media_mode": "carousel",
"vault_cleanup": true,
"vault_folder": true,
"mass_dm": {
"send_to": [
"Fans"
],
"exclude_lists": [
"Alt*"
],
"unsend_previous": true
}
},
"hosts": [
{
"of_account_id": 123,
"username": "<string>",
"session_status": "active"
}
],
"targets": [
{
"of_account_id": 123,
"username": "<string>",
"weight": 3,
"creatives": {
"story": 123,
"post": 123,
"bio": 123,
"mass_dm": 123
}
}
],
"published": {},
"created_at": "2023-11-07T05:31:56Z",
"created_at_ts": 123,
"updated_at": "2023-11-07T05:31:56Z",
"updated_at_ts": 123,
"overview": {
"progress": {
"day": 123,
"total_days": 123,
"published": 123,
"published_today": 123,
"planned_so_far": 123,
"planned_total": 123,
"pace": "on_pace"
},
"totals": {
"views": 123,
"clicks": 123,
"subscribers": 123,
"revenue_cents": 123
},
"by_format": [
{
"format": "story",
"published": 123,
"today": 123,
"failed": 123,
"live": 123,
"planned_so_far": 123,
"planned_total": 123,
"views": 123,
"sent": 123,
"clicks": 123,
"subscribers": 123,
"cr_percent": 123,
"revenue_cents": 123,
"arpu_cents": 123
}
],
"by_host": [
{
"of_account_id": 123,
"username": "<string>",
"published": 123,
"failed": 123,
"views": 123,
"last_at": "<string>"
}
],
"by_target": [
{
"of_account_id": 123,
"username": "<string>",
"published": 123,
"failed": 123,
"views": 123,
"last_at": "<string>"
}
]
}
}
}{
"success": false,
"error": "validation_failed",
"message": "<string>",
"details": {},
"retry_after": 123
}{
"success": false,
"error": "validation_failed",
"message": "<string>",
"details": {},
"retry_after": 123
}{
"success": false,
"error": "validation_failed",
"message": "<string>",
"details": {},
"retry_after": 123
}{
"success": false,
"error": "validation_failed",
"message": "<string>",
"details": {},
"retry_after": 123
}Shoutouts
Пул
One pool with its results.
GET
/
shoutouts
/
pools
/
{uuid}
Pool
curl --request GET \
--url https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid} \
--header 'X-API-Key: <api-key>'import requests
url = "https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}', 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://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}",
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;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}"
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))
}HttpResponse<String> response = Unirest.get("https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://studio-api.onlytraffic.com/api/external/v1/shoutouts/pools/{uuid}")
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{
"success": true,
"data": {
"pool_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Summer promo",
"status": "active",
"formats": [
"story"
],
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"rotation_type": "equal",
"daily_limits": {
"story": 2,
"mass_dm": 1
},
"same_target_cooldown_days": 123,
"friends_ttl_days": 123,
"bio_ttl_days": 123,
"post_ttl_days": 123,
"publish_settings": {
"pin_posts": true,
"post_media_mode": "carousel",
"vault_cleanup": true,
"vault_folder": true,
"mass_dm": {
"send_to": [
"Fans"
],
"exclude_lists": [
"Alt*"
],
"unsend_previous": true
}
},
"hosts": [
{
"of_account_id": 123,
"username": "<string>",
"session_status": "active"
}
],
"targets": [
{
"of_account_id": 123,
"username": "<string>",
"weight": 3,
"creatives": {
"story": 123,
"post": 123,
"bio": 123,
"mass_dm": 123
}
}
],
"published": {},
"created_at": "2023-11-07T05:31:56Z",
"created_at_ts": 123,
"updated_at": "2023-11-07T05:31:56Z",
"updated_at_ts": 123,
"overview": {
"progress": {
"day": 123,
"total_days": 123,
"published": 123,
"published_today": 123,
"planned_so_far": 123,
"planned_total": 123,
"pace": "on_pace"
},
"totals": {
"views": 123,
"clicks": 123,
"subscribers": 123,
"revenue_cents": 123
},
"by_format": [
{
"format": "story",
"published": 123,
"today": 123,
"failed": 123,
"live": 123,
"planned_so_far": 123,
"planned_total": 123,
"views": 123,
"sent": 123,
"clicks": 123,
"subscribers": 123,
"cr_percent": 123,
"revenue_cents": 123,
"arpu_cents": 123
}
],
"by_host": [
{
"of_account_id": 123,
"username": "<string>",
"published": 123,
"failed": 123,
"views": 123,
"last_at": "<string>"
}
],
"by_target": [
{
"of_account_id": 123,
"username": "<string>",
"published": 123,
"failed": 123,
"views": 123,
"last_at": "<string>"
}
]
}
}
}{
"success": false,
"error": "validation_failed",
"message": "<string>",
"details": {},
"retry_after": 123
}{
"success": false,
"error": "validation_failed",
"message": "<string>",
"details": {},
"retry_after": 123
}{
"success": false,
"error": "validation_failed",
"message": "<string>",
"details": {},
"retry_after": 123
}{
"success": false,
"error": "validation_failed",
"message": "<string>",
"details": {},
"retry_after": 123
}Один пул с настройками, участниками и результатами: прогресс относительно плана, итоги и разбивка по форматам, паблишерам и продвигаемым моделям. У рассылок в
by_format рядом с views (открыли) есть sent (охват). Клики, подписчики и доход относятся к трекинг-ссылкам креативов постов и рассылок.Была ли эта страница полезной?