Ads
Get messaging ad insights
Returns delivery/spend insights for the given ad ids. POST (not GET) since adIds can be up to 500 entries, too large for a query string.
POST
/
v1
/
ads
/
campaigns
/
insights
Get messaging ad insights
curl --request POST \
--url https://app.chatbotx.io/api/v1/ads/campaigns/insights \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"integrationId": "<string>",
"adAccountId": "<string>",
"adIds": [
"<string>"
],
"refresh": true
}
'import requests
url = "https://app.chatbotx.io/api/v1/ads/campaigns/insights"
payload = {
"integrationId": "<string>",
"adAccountId": "<string>",
"adIds": ["<string>"],
"refresh": True
}
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({
integrationId: '<string>',
adAccountId: '<string>',
adIds: ['<string>'],
refresh: true
})
};
fetch('https://app.chatbotx.io/api/v1/ads/campaigns/insights', 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.chatbotx.io/api/v1/ads/campaigns/insights",
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([
'integrationId' => '<string>',
'adAccountId' => '<string>',
'adIds' => [
'<string>'
],
'refresh' => true
]),
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.chatbotx.io/api/v1/ads/campaigns/insights"
payload := strings.NewReader("{\n \"integrationId\": \"<string>\",\n \"adAccountId\": \"<string>\",\n \"adIds\": [\n \"<string>\"\n ],\n \"refresh\": true\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.chatbotx.io/api/v1/ads/campaigns/insights")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"integrationId\": \"<string>\",\n \"adAccountId\": \"<string>\",\n \"adIds\": [\n \"<string>\"\n ],\n \"refresh\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chatbotx.io/api/v1/ads/campaigns/insights")
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 \"integrationId\": \"<string>\",\n \"adAccountId\": \"<string>\",\n \"adIds\": [\n \"<string>\"\n ],\n \"refresh\": true\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"adId": "<string>",
"currency": "<string>",
"impressions": 123,
"reach": 123,
"spend": 123,
"clicks": 123,
"conversations": 123,
"costPerConversation": 123
}
]
}{
"defined": true,
"code": "businessError",
"status": 400,
"message": "An error occurred while processing your request",
"data": "<unknown>"
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Authentication required",
"data": "<unknown>"
}{
"defined": true,
"code": "FORBIDDEN",
"status": 403,
"message": "You do not have permission to perform this action",
"data": "<unknown>"
}{
"defined": true,
"code": "invalidRequestData",
"status": 422,
"message": "Input validation failed",
"data": {
"issues": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}
}{
"defined": true,
"code": "tooManyRequests",
"status": 429,
"message": "Too many requests",
"data": "<unknown>"
}{
"defined": true,
"code": "INTERNAL_SERVER_ERROR",
"status": 500,
"message": "An unexpected error occurred",
"data": "<unknown>"
}Authorizations
bearerAuthdeveloperAccessTokentokenInSearchParams
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Channel the integration belongs to.
Available options:
messenger, instagram, whatsapp Channel integration id (numeric string).
Pattern:
^\d+$Meta ad account id (act_).
Pattern:
^act_\d+$Ad ids to fetch insights for, up to 500.
Required array length:
1 - 500 elementsMinimum string length:
1Meta date preset for the insights window.
Available options:
maximum, last_30d, last_7d Force an uncached refresh from Meta instead of serving cached data.
Response
OK
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Get messaging ad insights
curl --request POST \
--url https://app.chatbotx.io/api/v1/ads/campaigns/insights \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"integrationId": "<string>",
"adAccountId": "<string>",
"adIds": [
"<string>"
],
"refresh": true
}
'import requests
url = "https://app.chatbotx.io/api/v1/ads/campaigns/insights"
payload = {
"integrationId": "<string>",
"adAccountId": "<string>",
"adIds": ["<string>"],
"refresh": True
}
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({
integrationId: '<string>',
adAccountId: '<string>',
adIds: ['<string>'],
refresh: true
})
};
fetch('https://app.chatbotx.io/api/v1/ads/campaigns/insights', 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.chatbotx.io/api/v1/ads/campaigns/insights",
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([
'integrationId' => '<string>',
'adAccountId' => '<string>',
'adIds' => [
'<string>'
],
'refresh' => true
]),
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.chatbotx.io/api/v1/ads/campaigns/insights"
payload := strings.NewReader("{\n \"integrationId\": \"<string>\",\n \"adAccountId\": \"<string>\",\n \"adIds\": [\n \"<string>\"\n ],\n \"refresh\": true\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.chatbotx.io/api/v1/ads/campaigns/insights")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"integrationId\": \"<string>\",\n \"adAccountId\": \"<string>\",\n \"adIds\": [\n \"<string>\"\n ],\n \"refresh\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chatbotx.io/api/v1/ads/campaigns/insights")
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 \"integrationId\": \"<string>\",\n \"adAccountId\": \"<string>\",\n \"adIds\": [\n \"<string>\"\n ],\n \"refresh\": true\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"adId": "<string>",
"currency": "<string>",
"impressions": 123,
"reach": 123,
"spend": 123,
"clicks": 123,
"conversations": 123,
"costPerConversation": 123
}
]
}{
"defined": true,
"code": "businessError",
"status": 400,
"message": "An error occurred while processing your request",
"data": "<unknown>"
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Authentication required",
"data": "<unknown>"
}{
"defined": true,
"code": "FORBIDDEN",
"status": 403,
"message": "You do not have permission to perform this action",
"data": "<unknown>"
}{
"defined": true,
"code": "invalidRequestData",
"status": 422,
"message": "Input validation failed",
"data": {
"issues": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}
}{
"defined": true,
"code": "tooManyRequests",
"status": 429,
"message": "Too many requests",
"data": "<unknown>"
}{
"defined": true,
"code": "INTERNAL_SERVER_ERROR",
"status": 500,
"message": "An unexpected error occurred",
"data": "<unknown>"
}