Creatives

Creatives

curl --request GET \
  --url https://studio-api.onlytraffic.com/api/external/v1/shoutouts/creatives \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://studio-api.onlytraffic.com/api/external/v1/shoutouts/creatives"

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/creatives', 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/creatives",
  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/creatives"

	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://studio-api.onlytraffic.com/api/external/v1/shoutouts/creatives")

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": [
    {
      "creative_id": "550e8400-e29b-41d4-a716-446655440000",
      "account": {
        "of_account_id": 123,
        "username": "<string>"
      },
      "format": "story",
      "status": "active",
      "internal_name": "<string>",
      "text": "<string>",
      "generate_unique": true,
      "generation_keywords": "<string>",
      "create_campaign": true,
      "campaign_type": "regular",
      "campaign_trial_days": 123,
      "price_cents": 123,
      "price_locked": true,
      "media_count": 123,
      "stats": {
        "uses": 123,
        "views": 123
      },
      "created_at": "2023-11-07T05:31:56Z",
      "created_at_ts": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_at_ts": 123,
      "changed_at": "2023-11-07T05:31:56Z",
      "changed_at_ts": 123
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 50,
    "total": 150,
    "total_pages": 3,
    "has_next": true
  }
}

{
  "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
}

GET

shoutouts

creatives

Creatives

curl --request GET \
  --url https://studio-api.onlytraffic.com/api/external/v1/shoutouts/creatives \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://studio-api.onlytraffic.com/api/external/v1/shoutouts/creatives"

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/creatives', 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/creatives",
  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/creatives"

	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://studio-api.onlytraffic.com/api/external/v1/shoutouts/creatives")

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": [
    {
      "creative_id": "550e8400-e29b-41d4-a716-446655440000",
      "account": {
        "of_account_id": 123,
        "username": "<string>"
      },
      "format": "story",
      "status": "active",
      "internal_name": "<string>",
      "text": "<string>",
      "generate_unique": true,
      "generation_keywords": "<string>",
      "create_campaign": true,
      "campaign_type": "regular",
      "campaign_trial_days": 123,
      "price_cents": 123,
      "price_locked": true,
      "media_count": 123,
      "stats": {
        "uses": 123,
        "views": 123
      },
      "created_at": "2023-11-07T05:31:56Z",
      "created_at_ts": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_at_ts": 123,
      "changed_at": "2023-11-07T05:31:56Z",
      "changed_at_ts": 123
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 50,
    "total": 150,
    "total_pages": 3,
    "has_next": true
  }
}

{
  "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
}

Creatives are made in Studio (photos, texts, tracking link, price of a mass message); the API lists them and toggles their status. price_locked means the paid mass message already went out and keeps its price.

Authorizations

X-API-Key

string

header

required

Your API key from the Studio Dashboard

Query Parameters

page

integer

default:1

Page number, 1-indexed.

Required range: x >= 1

page_size

integer

default:50

Items per page. Default 50, max 100.

Required range: 1 <= x <= 100

of_account_id

integer

Creatives of one model.

Required range: x >= 1

format

enum<string>

Filter by format.

Available options:

story,

post,

bio,

mass_dm

status

enum<string>

Filter by status.

Available options:

active,

archived

since_changed_at

integer

Delta-sync filter. Return only rows whose changed_at is at or after this UNIX timestamp. Pair with until_changed_at for a window.

Required range: x >= 0

until_changed_at

integer

Delta-sync filter. Return only rows whose changed_at is strictly before this UNIX timestamp. Useful to lock the upper bound while paginating an open delta range.

Required range: x >= 0

sort

enum<string>

default:created_at_desc

Sort order.

Available options:

created_at_desc,

created_at_asc,

updated_at_desc

Response

Successful response

success

boolean

Example:

true

data

object[]

Show child attributes

pagination

object

Page-based pagination, returned by every list endpoint that isn't a cursor feed.

Show child attributes

Overview

Platforms

Work Formats

Tools

Payments & Safety

API & MCP

Authorizations

Query Parameters

Response