Public Report Snapshot
curl --request GET \
--url https://api.example.com/api/v1/public/share/reports/{token}import requests
url = "https://api.example.com/api/v1/public/share/reports/{token}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/public/share/reports/{token}', 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/public/share/reports/{token}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://api.example.com/api/v1/public/share/reports/{token}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/public/share/reports/{token}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/public/share/reports/{token}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"token": "<string>",
"report_type": "<string>",
"title": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"report": {
"status": "ok",
"date_preset": "<string>",
"generated_at": "2023-11-07T05:31:56Z",
"account_name": "<string>",
"currency": "<string>",
"date_start": "2023-12-25",
"date_end": "2023-12-25",
"rows": [
{
"group_key": "<string>",
"ad_name": "<string>",
"spend": 0,
"impressions": 0,
"clicks": 0,
"link_clicks": 0,
"outbound_clicks": 0,
"purchases": 0,
"purchase_value": 0,
"leads": 0,
"adds_to_cart": 0,
"video_views": 0,
"roas": 123,
"cpa": 123,
"aov": 123,
"cost_per_lead": 123,
"ctr": 123,
"ctr_outbound": 123,
"cpc": 123,
"cpc_link": 123,
"cpm": 123,
"click_to_atc_ratio": 123,
"atc_to_purchase_ratio": 123,
"thumbstop_ratio": 123,
"ad_count": 0,
"thumbnail_url": "<string>"
}
],
"totals": {
"spend": 0,
"impressions": 0,
"clicks": 0,
"link_clicks": 0,
"outbound_clicks": 0,
"purchases": 0,
"purchase_value": 0,
"leads": 0,
"adds_to_cart": 0,
"video_views": 0,
"roas": 123,
"cpa": 123,
"aov": 123,
"cost_per_lead": 123,
"ctr": 123,
"ctr_outbound": 123,
"cpc": 123,
"cpc_link": 123,
"cpm": 123,
"click_to_atc_ratio": 123,
"atc_to_purchase_ratio": 123,
"thumbstop_ratio": 123
}
},
"view": "<string>",
"creator_name": "<string>",
"card_metrics": [
"<string>"
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Public
Public Report Snapshot
Anonymous view of a frozen report snapshot (share page).
GET
/
api
/
v1
/
public
/
share
/
reports
/
{token}
Public Report Snapshot
curl --request GET \
--url https://api.example.com/api/v1/public/share/reports/{token}import requests
url = "https://api.example.com/api/v1/public/share/reports/{token}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/public/share/reports/{token}', 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/public/share/reports/{token}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://api.example.com/api/v1/public/share/reports/{token}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/public/share/reports/{token}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/public/share/reports/{token}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"token": "<string>",
"report_type": "<string>",
"title": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"report": {
"status": "ok",
"date_preset": "<string>",
"generated_at": "2023-11-07T05:31:56Z",
"account_name": "<string>",
"currency": "<string>",
"date_start": "2023-12-25",
"date_end": "2023-12-25",
"rows": [
{
"group_key": "<string>",
"ad_name": "<string>",
"spend": 0,
"impressions": 0,
"clicks": 0,
"link_clicks": 0,
"outbound_clicks": 0,
"purchases": 0,
"purchase_value": 0,
"leads": 0,
"adds_to_cart": 0,
"video_views": 0,
"roas": 123,
"cpa": 123,
"aov": 123,
"cost_per_lead": 123,
"ctr": 123,
"ctr_outbound": 123,
"cpc": 123,
"cpc_link": 123,
"cpm": 123,
"click_to_atc_ratio": 123,
"atc_to_purchase_ratio": 123,
"thumbstop_ratio": 123,
"ad_count": 0,
"thumbnail_url": "<string>"
}
],
"totals": {
"spend": 0,
"impressions": 0,
"clicks": 0,
"link_clicks": 0,
"outbound_clicks": 0,
"purchases": 0,
"purchase_value": 0,
"leads": 0,
"adds_to_cart": 0,
"video_views": 0,
"roas": 123,
"cpa": 123,
"aov": 123,
"cost_per_lead": 123,
"ctr": 123,
"ctr_outbound": 123,
"cpc": 123,
"cpc_link": 123,
"cpm": 123,
"click_to_atc_ratio": 123,
"atc_to_purchase_ratio": 123,
"thumbstop_ratio": 123
}
},
"view": "<string>",
"creator_name": "<string>",
"card_metrics": [
"<string>"
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Path Parameters
Response
Successful Response
Anonymous share-page payload — the frozen report plus display meta.
Anonymous-safe projection of a frozen What's Working report.
Drops the internal identifiers the share page never renders and that must
not be published on a capability link: brand_id (internal DB UUID),
account_id (the sharer's Meta ad-account number), and
account_timezone_name. Built from the stored payload at read time.
Show child attributes
Show child attributes
Was this page helpful?
⌘I