Create Whats Working Snapshot Route
curl --request POST \
--url https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reports/whats-working/snapshots \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"date_preset": "last_14d",
"since": "2023-12-25",
"until": "2023-12-25",
"sort_metric": "spend",
"card_metrics": [
"<string>"
],
"view": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reports/whats-working/snapshots"
payload = {
"date_preset": "last_14d",
"since": "2023-12-25",
"until": "2023-12-25",
"sort_metric": "spend",
"card_metrics": ["<string>"],
"view": "<string>"
}
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({
date_preset: 'last_14d',
since: '2023-12-25',
until: '2023-12-25',
sort_metric: 'spend',
card_metrics: ['<string>'],
view: '<string>'
})
};
fetch('https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reports/whats-working/snapshots', 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.example.com/api/v1/brands/{brand_id}/brand-intelligence/reports/whats-working/snapshots",
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([
'date_preset' => 'last_14d',
'since' => '2023-12-25',
'until' => '2023-12-25',
'sort_metric' => 'spend',
'card_metrics' => [
'<string>'
],
'view' => '<string>'
]),
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://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reports/whats-working/snapshots"
payload := strings.NewReader("{\n \"date_preset\": \"last_14d\",\n \"since\": \"2023-12-25\",\n \"until\": \"2023-12-25\",\n \"sort_metric\": \"spend\",\n \"card_metrics\": [\n \"<string>\"\n ],\n \"view\": \"<string>\"\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://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reports/whats-working/snapshots")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"date_preset\": \"last_14d\",\n \"since\": \"2023-12-25\",\n \"until\": \"2023-12-25\",\n \"sort_metric\": \"spend\",\n \"card_metrics\": [\n \"<string>\"\n ],\n \"view\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reports/whats-working/snapshots")
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 \"date_preset\": \"last_14d\",\n \"since\": \"2023-12-25\",\n \"until\": \"2023-12-25\",\n \"sort_metric\": \"spend\",\n \"card_metrics\": [\n \"<string>\"\n ],\n \"view\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"token": "<string>",
"report_type": "<string>",
"title": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"share_path": "<string>",
"date_start": "2023-12-25",
"date_end": "2023-12-25",
"date_preset": "<string>",
"view": "<string>",
"creator_name": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Brand Intelligence
Create Whats Working Snapshot Route
Freeze the current What’s Working report into a public share link.
The report is re-generated server-side from the supplied configuration — the client never uploads payload data.
POST
/
api
/
v1
/
brands
/
{brand_id}
/
brand-intelligence
/
reports
/
whats-working
/
snapshots
Create Whats Working Snapshot Route
curl --request POST \
--url https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reports/whats-working/snapshots \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"date_preset": "last_14d",
"since": "2023-12-25",
"until": "2023-12-25",
"sort_metric": "spend",
"card_metrics": [
"<string>"
],
"view": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reports/whats-working/snapshots"
payload = {
"date_preset": "last_14d",
"since": "2023-12-25",
"until": "2023-12-25",
"sort_metric": "spend",
"card_metrics": ["<string>"],
"view": "<string>"
}
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({
date_preset: 'last_14d',
since: '2023-12-25',
until: '2023-12-25',
sort_metric: 'spend',
card_metrics: ['<string>'],
view: '<string>'
})
};
fetch('https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reports/whats-working/snapshots', 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.example.com/api/v1/brands/{brand_id}/brand-intelligence/reports/whats-working/snapshots",
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([
'date_preset' => 'last_14d',
'since' => '2023-12-25',
'until' => '2023-12-25',
'sort_metric' => 'spend',
'card_metrics' => [
'<string>'
],
'view' => '<string>'
]),
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://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reports/whats-working/snapshots"
payload := strings.NewReader("{\n \"date_preset\": \"last_14d\",\n \"since\": \"2023-12-25\",\n \"until\": \"2023-12-25\",\n \"sort_metric\": \"spend\",\n \"card_metrics\": [\n \"<string>\"\n ],\n \"view\": \"<string>\"\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://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reports/whats-working/snapshots")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"date_preset\": \"last_14d\",\n \"since\": \"2023-12-25\",\n \"until\": \"2023-12-25\",\n \"sort_metric\": \"spend\",\n \"card_metrics\": [\n \"<string>\"\n ],\n \"view\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/brands/{brand_id}/brand-intelligence/reports/whats-working/snapshots")
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 \"date_preset\": \"last_14d\",\n \"since\": \"2023-12-25\",\n \"until\": \"2023-12-25\",\n \"sort_metric\": \"spend\",\n \"card_metrics\": [\n \"<string>\"\n ],\n \"view\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"token": "<string>",
"report_type": "<string>",
"title": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"share_path": "<string>",
"date_start": "2023-12-25",
"date_end": "2023-12-25",
"date_preset": "<string>",
"view": "<string>",
"creator_name": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
The report configuration to freeze — the server re-generates the report from these params and stores the result; the client never supplies payload data.
Response
Successful Response
Was this page helpful?
⌘I